Re: [Graphviz] building doc with Python3

[email protected] wrote:
> On 2015-02-26 20:08 Robin Dunn<[email protected]>  wrote:
>> So you need to run the commands dox, etg, and sphinx, in that order.
>
> It is the first time I heard of etg command in the case of producing
> docu.

Really?  That's not even the first time I mentioned it in this thread. 
And I'm pretty sure I mentioned it at least once in another message 
thread last week too.

>
>> If you also want
>> to run wx.lib, wx.py and wx.tools through Sphinx
>
> What would be the result of that compared to only "dox etc sphinx"?
> Which parts of the docu whould be missing.

The docs for the modules in the wx.lib, wx.py and wx.tools packages. 
Isn't that kinda obvious?  Especially since the build.py help says:

       wxlib         Build the Sphinx input files for wx.lib
       wxpy          Build the Sphinx input files for wx.py
       wxtools       Build the Sphinx input files for wx.tools


> Of course I read README.rst

Um, are you sure?

> but the build.py commands themselfs are not
> documented.

See the section titled "Important build.py commands" and also run 
"python build.py --help" as it suggests. And "Use the source Luke!" the 
answers to all questions are there. Somewhere.


> I currently don't know where Point.Get() comes from because
> it is not in the C++ header file and I found no "tweaker" file about it.
>

 From the README.rst file:

"""
To help keep things a little easier when looking for things that need to be
worked on, the file names in the Phoenix project will mirror the names 
of the
files in the wxWidgets interface headers folder. For example, if there is a
interface/wx/FOO.h and we are processing the XML produced for that file then
the ETG script for the classes and other items will be named etg/FOO.py 
and it
will produce sip/gen/FOO.sip, unit tests will be in unittests/test_FOO.py,
and so on.
"""


So that should lead you to etg/gdicmn.py, which has a section that 
starts with:

     # wxPoint tweaks
     c = module.find('wxPoint')

and it also has this code a little further on from there:

     c.addCppMethod('PyObject*', 'Get', '()', """\
         return sipBuildResult(0, "(ii)", self->x, self->y);
         """,
         pyArgsString="() -> (x,y)",
         briefDoc="Return the x and y properties as a tuple.")



-- 
Robin Dunn
Software Craftsman
http://wxPython.org

-- 
You received this message because you are subscribed to the Google Groups "wxPython-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
For more options, visit https://groups.google.com/d/optout.