pydoc usage and other documentation tools

[Bernhard Reiter]

pydoc coming with Python can be quite useful as a class browser.
If you want to use it on Thuban, you need to give it the right
paths so you can browse all of it.

e.g. , the following starts pydoc as webbrowser on localhost:1234/
        cd root/thuban
        PYTHONPATH=./Lib:./test/ pydoc -p 1234

I briefly looked into other documentation tools
and the best overview about them was coming with epydoc at:
http://epydoc.sourceforge.net/relatedprojects.html

epydoc seems to be very solid, because the author did a lot
of reseach and decided for a very simple markup language.
It might be surpased one day by docutils which use the more
complicated reStructured text as markup.

As nice side contender is happydoc, because it does not import
the python modules.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://www.intevation.de/pipermail/thuban-devel/attachments/20040921/919e4db6/attachment.bin