Automatic documentation options

Terry Hancock hancock at anansispaceworks.com
Sun Aug 21 10:35:32 EDT 2005


On Sunday 21 August 2005 07:37 am, Terry Hancock wrote:
> I've been trying to use "happydoc" to document a source
> tree that I'm working on. 
> [...]
> Any suggestions on getting pydoc, happydoc, or yet another
> documentation generator to do this, would be greatly appreciated.

Ah, well, it looks like epydoc will do what I need
http://epydoc.sourceforge.net

The module import error I mentioned was actually a real bug
in my sources, when fixed, pydoc (and epydoc) don't seem to
have a problem with them. Doesn't address the general issue,
but it works fine for this project.

The only remaining problem is that epydoc doesn't seem to 
understand Structured Text, despite having an option for
it ('--docformat="restructuredtext"').  Good enough though.

Cheers,
Terry

--
Terry Hancock ( hancock at anansispaceworks.com )
Anansi Spaceworks  http://www.anansispaceworks.com




More information about the Python-list mailing list