Phoenix doc - build instructions

wxPython Dev
1

Hi Andrea or Robin,

There are still issues with the pdfViewer doc:

pdfViewer link issue:
this one works:
http://wxpython.org/Phoenix/docs/html/_sources/lib.pdfviewer.viewer.txt

this one doesn't:
http://wxpython.org/Phoenix/docs/html/lib.pdfviewer.html

Should this one use :class:`~lib.pdfviewer.pdfViewer` , not sure as it didn't work for :class:`~lib.pdfviewer.pdfButtonPanel` which Andrea set and I changed back with the last patch.

Sample code:
self.viewer.UsePrintDirect = ``False``

I like to see if I can find the right format to use but would need to build locally - so are there build instructions to just build the doc from SVN?

Werner

2

Hi Werner,

···

On 3 April 2013 12:30, Werner wrote:

Hi Andrea or Robin,

There are still issues with the pdfViewer doc:

pdfViewer link issue:

this one works:

http://wxpython.org/Phoenix/docs/html/_sources/lib.pdfviewer.viewer.txt

this one doesn’t:

http://wxpython.org/Phoenix/docs/html/lib.pdfviewer.html

Should this one use :class:~lib.pdfviewer.pdfViewer , not sure as it didn’t work for :class:~lib.pdfviewer.pdfButtonPanel which Andrea set and I changed back with the last patch.

Yes, it should be :class:~lib.pdfviewer.viewer.pdfViewer (and :class:~lib.pdfviewer.buttonpanel.pdfButtonPanel) , as otherwise Sphinx will not know where to look for pdfViewer (even though there is a .. currentmodule:: and .. module:: declaration at the top of the source file…

Sample code:

self.viewer.UsePrintDirect = False

I like to see if I can find the right format to use but would need to build locally - so are there build instructions to just build the doc from SVN?

This is a bug in the sphinxgenerator.py file, when it tries to be smart (and it fails). It shouldn’t reformat Python source code, only text. I’ll see if I can fix it this evening or tomorrow.

Andrea.

“Imagination Is The Only Weapon In The War Against Reality.”
http://www.infinity77.net

-------------------------------------------------------------

def ask_mailing_list_support(email):

if mention_platform_and_version() and include_sample_app():
    send_message(email)
else:

    install_malware()
    erase_hard_drives()

-------------------------------------------------------------

3

That is also managed by build.py like most of the other build stuff in Phoenix. The generation of the sphinx input files for the wrapped extension modules happens when the etg files are run (and the --nodoc flag is not given) and there are additional commands (like wxlib) to extract docs from wx.lib, and other pure python packages. Finally build.py's sphinx command will run Sphinx to generate the html files. If you want to force the etg scripts to be rerun (so you get the sphinx files regenerated) then run "build.py touch". See "build.py help" for more details. Multiple commands can be run together with a single invocation of build.py by specifying them all on the command-line.

···

On 3 April 2013 12:30, Werner wrote:

    I like to see if I can find the right format to use but would need
    to build locally - so are there build instructions to just build the
    doc from SVN?

--
Robin Dunn
Software Craftsman

4

Robin Dunn wrote:

···

On 3 April 2013 12:30, Werner wrote:

I like to see if I can find the right format to use but would need
to build locally - so are there build instructions to just build the
doc from SVN?

That is also managed by build.py like most of the other build stuff in
Phoenix. The generation of the sphinx input files for the wrapped
extension modules happens when the etg files are run (and the --nodoc
flag is not given) and there are additional commands (like wxlib) to
extract docs from wx.lib, and other pure python packages. Finally
build.py's sphinx command will run Sphinx to generate the html files. If
you want to force the etg scripts to be rerun (so you get the sphinx
files regenerated) then run "build.py touch". See "build.py help" for
more details. Multiple commands can be run together with a single
invocation of build.py by specifying them all on the command-line.

I should also mention that the etg files require that the XML for the wx docs has been generated. So you will also need the wxWidgets source tree (preferably located as a sibling to the Phoenix source tree) and the build.py dox command will then run doxygen on those files so the etg scripts have something to work with.

--
Robin Dunn
Software Craftsman