jan: thuban/Doc README,NONE,1.1

[cvs@intevation.de]

Author: jan

Update of /thubanrepository/thuban/Doc
In directory doto:/tmp/cvs-serv4024

Added Files:
	README 
Log Message:
Some info about how to generate technical documentation
from the source code.
This text was send to the Thuban developer mailing list on
September 21st 2004 by Bernhard Reiter.


--- NEW FILE: README ---
$Id: README,v 1.1 2004/09/22 22:33:47 jan Exp $

Currently, there is no explicit document on the implementation
details. But you can generate class and method description
automatically from the source code:

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 thuban
        PYTHONPATH=./Lib:./test/ pydoc -p 1234

A brief look into other documentation tools
resulted in that the 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.