Re: Generating API documentation as a textfile

2007-12-04 Thread Laurent Pointal
MonkeeSage a écrit : > On Dec 3, 8:58 am, Samuel <[EMAIL PROTECTED]> wrote: >> On Mon, 03 Dec 2007 06:45:45 -0800, Giampaolo Rodola' wrote: >>> dir.__doc__ >> This contains only the docstring one object (module, class, >> function, ...). I was thinking more of the complete API documentation >> that

Re: Generating API documentation as a textfile

2007-12-03 Thread MonkeeSage
On Dec 3, 8:58 am, Samuel <[EMAIL PROTECTED]> wrote: > On Mon, 03 Dec 2007 06:45:45 -0800, Giampaolo Rodola' wrote: > > dir.__doc__ > > This contains only the docstring one object (module, class, > function, ...). I was thinking more of the complete API documentation > that can be found in a file,

Re: Generating API documentation as a textfile

2007-12-03 Thread Jeff McNeil
Check out the 'pydoc' script; it ships with Python. I've got my CI system rigged up to run pydoc on each commit and automatically generate HTML documentation. The tool actually imports a 'pydoc.py' module, which you may be able to use directly if you need more control over the process. On top o

Re: Generating API documentation as a textfile

2007-12-03 Thread Samuel
On Mon, 03 Dec 2007 06:45:45 -0800, Giampaolo Rodola' wrote: > dir.__doc__ This contains only the docstring one object (module, class, function, ...). I was thinking more of the complete API documentation that can be found in a file, and formatted in a readable way. -Samuel -- http://mail.pyt

Re: Generating API documentation as a textfile

2007-12-03 Thread Giampaolo Rodola'
On 3 Dic, 11:26, Samuel <[EMAIL PROTECTED]> wrote: > Does anyone know an easy way to extract the API documentation that is > embedded into a Python file as a text file? > > -Samuel Something like this? print >> open('file.txt', 'w'), dir.__doc__ -- http://mail.python.org/mailman/listinfo/python-

Generating API documentation as a textfile

2007-12-03 Thread Samuel
Does anyone know an easy way to extract the API documentation that is embedded into a Python file as a text file? -Samuel -- http://mail.python.org/mailman/listinfo/python-list