Re: [Docutils-develop] documenting python progs

[Richard J. <rj...@ek...>]

On Wed, 9 Oct 2002 5:15 am, Mathew Yeates wrote:
> Hi-
>
> I take it that doc utils cannot currently be used for
> extracting documentation from doc strings. Bummer.
> This will be an awesome feature when it finally makes it in.

Feel free to poke around the pysource sandbox :)

I recently hacked together the rjhack.py script in that directory that will 
produce a page of documentation for a python module or package. I just needs:

a) splitting into multiple files,
b) a nicer, more relevant stylesheet, and
c) additional index pages generated.

so, not much work at all ;)


> In the meantime, what is everybody using for python documentation?

epydoc does a fair job, but it's limited by two factors:

a) you've got to set up your list of modules for it - it won't automatically
   discover a package's contents, and
b) it works by importing the modules, so run-time-only modules, or those with
   unsatisfied dependencies, won't get documented. It also doesn't handle
   attribute docstrings.

It does produce nice output though :)  See the api docs at 
http://roundup.sf.net/ for an example.


      Richard