Best way to document Python code...

[Stuart D. Gathman]

On Mon, 22 Jan 2007 17:35:18 -0500, Stuart D. Gathman wrote:

> The HTML generated by pydoc doesn't link to standard modules properly. 
> They are generated as relative links.  So it can't be used without
> modification for generating docs for a web page about a python package. 
> 
> I'm struggling with the same issue.  Coding Python is so much easier than
> Java.  However documenting Java is so much easier than Python.  Just
> include doc comments, run javadoc, and voila!

Wow!  I just tried epydoc, and it is every bit as easy as javadoc and
with similar output. Too bad it isn't standard.  But the comments and
docstrings it parses work fine with pydoc also.

-- 
	      Stuart D. Gathman <stuart at bmsi.com>
Business Management Systems Inc.  Phone: 703 591-0911 Fax: 703 591-6154
"Confutatis maledictis, flamis acribus addictis" - background song for
a Microsoft sponsored "Where do you want to go from here?" commercial.