[Doc-SIG] Documentation from docstrings

M.-A. Lemburg mal@lemburg.com
Fri, 03 Nov 2000 21:06:53 +0100

Andrew Kuchling wrote:
> I haven't been following this area recently, so... what are the
> current tools used to generate HTML (or TeX/XML/whatever) from
> docstrings?  There's pythondoc, ?!ng's htmldoc... any others?  What do
> most people use for this task?

There's my old doc.py. It produces the classical two frames
HTML output. Good for quick shot Python project documentation...

I've turned away from these tools though and now use a combination
doc-string extractor -> StarOffice import -> GhostScript PDF export 
to do documentation. This allows better hand-editing of the generated
output, since doc-strings usually don't suffice when it
comes to documenting code.

Marc-Andre Lemburg
Business:                                      http://www.lemburg.com/
Python Pages:                           http://www.lemburg.com/python/