[Doc-SIG] Using docutils on source code

David Goodger goodger@python.org
Fri, 04 Apr 2003 18:51:18 -0500


Juergen Hermann wrote:
> Maybe I'm thick here, but from a more than cursory look at the docs I 
> got the impression that docutils is still "just" a document processor, 
> and that there is no front-end to extract docstrings from source and 
> format them.
 >
> Can somebody enlighten me, and shove me in the right direction?

Docstring extraction is still under development (you're not thick, at 
least not in this instance ;-).  I have most of a source code parsing 
module in docutils/readers/python/moduleparser.py.  I haven't worked on 
it in a while, but I do plan to finish it eventually.  Ian Bicking wrote 
an initial front end for my moduleparser module, in 
sandbox/ianb/extractor/extractor.py.

-- 
David Goodger    http://starship.python.net/~goodger

Programmer/sysadmin for hire: http://starship.python.net/~goodger/cv