pythondoc or epydoc?

Remco Boerma remco at tomaatnet.nl
Fri Oct 8 06:39:49 EDT 2004


Christian Helmbold wrote:

> So I want to know what you suggest: pythondoc, epydoc or something
> else? What is more 'offical'?

Using epydoc (as i've used that one before) give's you the option to use 
reStructuredText. With that, it's very easy to get some markup and 
special meaning to your documentation. It's capable of javadoc like 
syntax and reST. . . But be carefull though, as epydoc imports your 
modules, so make sure every module you have that ought to do something 
automagically uses something like:

[code]
if __name__ == "__main__":
	pass #code here
[/code]

else, it will be run everytime you generate your code :) [i've had that 
with a QUAD cleanup script- so everything was cleaned allright]

Cheers!
Remco Boerma




More information about the Python-list mailing list