Re: What tools are used to write and generate Python Library documentation.

2005-09-28 Thread Terry Hancock
On Tuesday 27 September 2005 07:22 pm, Robert Kern wrote: > Terry Hancock wrote: > > On Monday 26 September 2005 10:24 pm, Kenneth McDonald wrote: > > > >>I have a module I'd like to document using the same style... > > > > Google for "epydoc", "pydoc", and "happydoc". > > > > You've already rec

Re: What tools are used to write and generate Python Library documentation.

2005-09-28 Thread Reinhold Birkenfeld
Kenneth McDonald wrote: > I have a module I'd like to document using the same style... The Python Library documentation is written in LaTeX and converted to HTML with latex2html. The relevant style and source files are in the Python CVS tree. Reinhold -- http://mail.python.org/mailman/listinfo/p

Re: What tools are used to write and generate Python Library documentation.

2005-09-27 Thread Robert Kern
Terry Hancock wrote: > On Monday 26 September 2005 10:24 pm, Kenneth McDonald wrote: > >>I have a module I'd like to document using the same style... > > Google for "epydoc", "pydoc", and "happydoc". > > You've already received a comment about markup standards, > although you will find more info

Re: What tools are used to write and generate Python Library documentation.

2005-09-27 Thread Terry Hancock
On Monday 26 September 2005 10:24 pm, Kenneth McDonald wrote: > I have a module I'd like to document using the same style... Google for "epydoc", "pydoc", and "happydoc". You've already received a comment about markup standards, although you will find more information at the web pages for the abo

Re: What tools are used to write and generate Python Library documentation.

2005-09-27 Thread Michael Ekstrand
On Sep 27, 2005, at 12:45 PM, Kenneth McDonald wrote: > It's too bad that there is no equivalent of d'oxygen for Python. That > is a _nice_ program. I've been using epydoc (http://epydoc.sourceforge.net) for a while now, and it's really nice. The output is very much in the style of Javadoc. Its

Re: What tools are used to write and generate Python Library documentation.

2005-09-27 Thread Kenneth McDonald
Unfortunately, none of the documentation tools that use documentation strings are suitable for full, serious documentation. There are a number of reasons for this, and I'll touch on a few. The obvious one is that there is no standard format for docstrings, and this creates problems when tryi

Re: What tools are used to write and generate Python Library documentation.

2005-09-26 Thread Robert Kern
Kenneth McDonald wrote: > I have a module I'd like to document using the same style... http://docs.python.org/doc/doc.html -- Robert Kern [EMAIL PROTECTED] "In the fields of hell where the grass grows high Are the graves of dreams allowed to die." -- Richard Harter -- http://mail.python.or

Re: What tools are used to write and generate Python Library documentation.

2005-09-26 Thread beza1e1
Do you think of pydoc? Just make comments in your code this way: def add10(x): """this function adds ten to the given variable""" Then save this into add.py and now (in the same directory): pydoc add Voila, your documentation. -- http://mail.python.org/mailman/listinfo/python-list

Re: What tools are used to write and generate Python Library documentation.

2005-09-26 Thread James Stroud
ReStructureText is pretty cool. Try it out. http://docutils.sourceforge.net/rst.html On Monday 26 September 2005 20:24, Kenneth McDonald wrote: > I have a module I'd like to document using the same style... > > Thanks, > Ken -- James Stroud UCLA-DOE Institute for Genomics and Proteomics Box 951

What tools are used to write and generate Python Library documentation.

2005-09-26 Thread Kenneth McDonald
I have a module I'd like to document using the same style... Thanks, Ken -- http://mail.python.org/mailman/listinfo/python-list