Hi All,
I have committed all my Python scripts to generate the ReST
docstrings input for Sphinx, plus some more things, into the latest
SVN Phoenix branch. In addition to the scripts, this is what I have
done:
1) I have translated all the wxWidgets overviews for the classes
ported to Phoenix until now (25 *.rst files into the
"docs/sphinx/rest_substitutions/overviews/" folder
2) All the C++ snippet of code present in the wxWidgets XML docstrings
have been translated for the classes ported to Phoenix up to now,
except a few of them for which I have no idea of how to translate them
or if even it makes sense to translate them (my scripts will issue a
warning if they find an unconverted snippet of code, so you can see
which ones they are). They live in the
"docs/sphinx/rest_substitutions/snippets/python/converted" folder for
the converted Python ones, and in the
"docs/sphinx/rest_substitutions/snippets/cpp" folder for the raw C++
ones (these gets generated at runtime, so you won't see them in the
SVN commit).
3) I have merged some of the screenshots of widgets Werner has sent me
(sorry I didn't have time to put them all in, I'll do it soon). These
are only MSW screenshots. A special thanks to Werner for all the
screenies he has sent me the last few days, impressive job.
4) I have slightly modified 3 or 4 of already existing Python files in
SVN, namely the extractors.py, generators.py and tweaker_tools.py,
together with the main build.py script to add the documentation
building process. In this regard, the way you call the building script
should be:
python build.py touch etg sphinx
the "sphinx" command must always be the last one called, as it depends
on what the generators do during the "etg" command If you have already
run the "touch etg" commands, then you can simply write:
python build.py sphinx
And this will create the HTML documentation.
5) The newly generated documentation is here:
http://xoomer.virgilio.it/infinity77/Phoenix/main.html
I didn't manage to put docstrings and comment everywhere into my
Python scripts, but this is something I will have to do because some
hacks really need clarifications. I am committing this stuff now as I
am going to Kenya for 2 weeks on holiday and I won't even look at a
computer for those 15 days 
. In any case, if the developers can
resist the urge of heavily modifying the Python scripts in the
"sphinxtools" folder and the "sphinx_generator.py" file for 15 days,
then I'll complete the docstrings and comment them all so it will be
clearer what they are actually doing. I will also take a look at if
(and how) the scripts may break once Robin/Kevin start adding more and
more new classes to Phoenix.
In some places the scripts may seem a bit too convoluted, but you
should have seen the mess they were before I refactored them
completely during the last week.
** NOTE **: if any developer wishes to add some more documentation
stuff (like new overviews, other pure-Python specific stuff,
whatever), please **do not** use the *.txt extension if you work in
any of the /docs/sphinx/ sub-folders. Please use the *.rst format.
There is no problem if you work on a higher level folder (right now we
have the MigrationGuide.txt and the TODO.txt files up in the directory
hierarchy).
The various sub-folders I have created in the SVN repository will need
some kind of README, but I really have run out of time. I'll do it
when I get back.
There are a number of wxWidgets documentation bugs I found while
working on this thing, I'll make a summary when I get back if anyone
is interested.
Andrea.
"Imagination Is The Only Weapon In The War Against Reality."
http://xoomer.alice.it/infinity77/
import PyQt4.QtGui
Traceback (most recent call last):
File "<interactive input>", line 1, in <module>
ImportError: No module named PyQt4.QtGui
import pygtk
Traceback (most recent call last):
File "<interactive input>", line 1, in <module>
ImportError: No module named pygtk
···
import wx
