how to create module documentation: gendoc? pythondoc? other?

Ben Finney bignose-hates-spam at and-zip-does-too.com.au
Tue Jun 3 07:30:54 CEST 2003


On 2 Jun 2003 22:18:01 -0700, Jeff McCarrell wrote:
> What is the preferred method to autogenerate module documentation
> these days?

There is a great momentum behind the docutils project, using
reStructured Text as the preferred docstring format:

  <http://docutils.sourceforge.net/>

Currently, though, docutils is still in development.  I'm not sure of
the preferred docstring-to-documentation generator for released versions
of Python.

-- 
 \      "For my birthday I got a humidifier and a de-humidifier. I put |
  `\      them in the same room and let them fight it out."  -- Steven |
_o__)                                                           Wright |
http://bignose.squidly.org/ 9CFE12B0 791A4267 887F520C B7AC2E51 BD41714B




More information about the Python-list mailing list