[Doc-SIG] Documentation from docstrings

Janko Hauser jhauser@ifm.uni-kiel.de
Fri, 3 Nov 2000 21:31:28 +0100 (CET)

There is also HappyDoc. One big difference is, that it does not import
the modules and extracts the docstring but parses the actual code. So
it is not suited to document extension modules. Another thing is, that
one can write new backend to format the doc strings.

Then there is also Crystal at


These two are relative mature. I always wonder, why especially new
python users find the pythondoc module, which seems to have
problems. Is it linked in a popular place?


M.-A. Lemburg writes:
 > 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.