Sphinxed Phoenix Documentation (6)
Andrea Gavana <andrea.gavana <at> gmail.com>
2012-04-07 22:16:38 GMT
Hi All,
as an Easter present, I am happy to release a new set of
documentation pages for Phoenix, which is available here:
http://xoomer.virgilio.it/infinity77/Phoenix/main.html
I have managed to run the whole of Phoenix, wx.lib, wx.py and wx.tools
via Sphinx - basically everything we have in wxPython.
Also, most (if not all) the Epydoc docstring hyperlinks which are
present in Editra, XRCed and in some place else (i.e., the ones with
L{something}, U{something}, C{something} and so on) are automatically
handled by the docstrings scanner, so you will see most of them
converted to proper links in the HTML documentation.
Werner, I have updated the I18N sample to the latest specs.
There is still some work to do, of course, especially on improving the
docstrings themselves in wx.lib and wx.tools. Editra is well
documented but the automatic sphinx_generator tool can't possibly
convert, without sometimes failing, docstrings that are meant for
Doxygen to Sphinx-compliant ones.
Cody, do you mind me making some slight changes to the docstrings in
Editra or will you prefer a patch against the latest SVN version?
In any case, I think the overall result is good (and with only 70
warnings from Sphinx...). Please let me know if you find anything
strange, and also your thoughts on possible modifications, additions,
(Continue reading)