[Doc-SIG] docutils, ReST, and pydoc

Nicola Larosa nico at tekNico.net
Tue Mar 7 08:21:32 CET 2006

>> That is, it looks like they're building a very general tool,
>> whereas Python may simply need to have pydoc properly render
>> ReST in docstrings so I can run "pydoc some_module" and
>> get some nice manpage-style (perldoc style) documentation
>> right there in my terminal.

> Such tools already exist, such as Epydoc, Pudge, and Endo.  Simply
> rendering reST is easy.  Adding hyperlinks and the correct context is
> the challenge.  Doing it without importing the code you're documenting
> is important too.

For reference:



Endo (part of the Enthought Tool Suite)

Did not know about this, thanks David.

There's also docextractor:


API docs

Nicola Larosa - http://www.tekNico.net/

It will always be true that people that drive slower than me are morons,
and people that drive faster than me are idiots. :)
 -- Matthew Carlisle on Slashdot, December 2005

More information about the Doc-SIG mailing list