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

Ian Bicking ianb at colorstudy.com
Wed Jun 4 05:27:13 CEST 2003


On Tue, 2003-06-03 at 00:30, Ben Finney wrote:
> 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.

I'm pretty sure there's no extractor.  Well, there's an extractor of
sorts, but nothing to assemble the result.  I made a crude
extractor/assembler myself (in docutils CVS, module sandbox,
ianb/extractor/), but I wouldn't really recommend it highly.

  Ian







More information about the Python-list mailing list