Re: Best way to document Python code...

2007-01-24 Thread Nick Vatamaniuc
Epydoc is the way to go. You can even choose between various formating standards (including javadoc ) and customize the output using CSS. On Jan 22, 7:51 pm, "Stuart D. Gathman" <[EMAIL PROTECTED]> wrote: > On Mon, 22 Jan 2007 17:35:18 -0500, Stuart D. Gathman wrote: > > The HTML generated by py

Re: Best way to document Python code...

2007-01-23 Thread Neil Cerutti
On 2007-01-22, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > Boris Ozegovic: >> Does Python has API just like in Java, for example >> http://java.sun.com/j2se/1.5.0/docs/api/allclasses-noframe.html ctrl-f and >> than click on class you are searching for, and finally you get clean list >> of all fi

Re: Best way to document Python code...

2007-01-22 Thread Paddy
Scott Huey wrote: > I am working on a Python module and I would like to prepare some API > documentaiton. I managed to find epydoc after some searching online. > > Is there a standard way to document the API for Python modules? Is > epydoc the best way to go if there is no standard? Are there oth

Re: Best way to document Python code...

2007-01-22 Thread Stuart D. Gathman
On Mon, 22 Jan 2007 17:35:18 -0500, Stuart D. Gathman wrote: > The HTML generated by pydoc doesn't link to standard modules properly. > They are generated as relative links. So it can't be used without > modification for generating docs for a web page about a python package. > > I'm struggling

Re: Best way to document Python code...

2007-01-22 Thread Stuart D. Gathman
On Mon, 22 Jan 2007 20:40:57 +, Adonis Vargas wrote: > But a quick look at pydoc (not to be confused with epydoc) > which is part of the standard library allows you to generate > documentation in HTML format, and/or serve it over web with its built-in > HTTP server. > > pydoc: http://docs.

Re: Best way to document Python code...

2007-01-22 Thread Gabriel Genellina
At Monday 22/1/2007 17:48, Boris Ozegovic wrote: Does Python has API just like in Java, for example http://java.sun.com/j2se/1.5.0/docs/api/allclasses-noframe.html ctrl-f and than click on class you are searching for, and finally you get clean list of all fields and methods. Where can I find si

Re: Best way to document Python code...

2007-01-22 Thread bearophileHUGS
Boris Ozegovic: > Does Python has API just like in Java, for example > http://java.sun.com/j2se/1.5.0/docs/api/allclasses-noframe.html ctrl-f and > than click on class you are searching for, and finally you get clean list > of all fields and methods. Where can I find similar in Python, for > examp

Re: Best way to document Python code...

2007-01-22 Thread Boris Ozegovic
Adonis Vargas wrote: > Then Python will generate a quick help interface for your module. I Hi Does Python has API just like in Java, for example http://java.sun.com/j2se/1.5.0/docs/api/allclasses-noframe.html ctrl-f and than click on class you are searching for, and finally you get clean list o

Re: Best way to document Python code...

2007-01-22 Thread Adonis Vargas
Scott Huey wrote: > I am working on a Python module and I would like to prepare some API > documentaiton. I managed to find epydoc after some searching online. > > Is there a standard way to document the API for Python modules? Is > epydoc the best way to go if there is no standard? Are there othe

Best way to document Python code...

2007-01-22 Thread Scott Huey
I am working on a Python module and I would like to prepare some API documentaiton. I managed to find epydoc after some searching online. Is there a standard way to document the API for Python modules? Is epydoc the best way to go if there is no standard? Are there other ways to document a Python