ANN: PythonDoc 2.1 beta 1 (september 1, 2004)

Fredrik Lundh fredrik at
Wed Sep 1 20:01:47 CEST 2004

PythonDoc is a documentation tool for Python, inspired by JavaDoc.

Like JavaDoc, PythonDoc scans your Python code for doc comments,
and generates API documentation in XML and HTML formats.  Python-
Doc supports basic JavaDoc tags like @param and @return, and adds
a few Python-specific tags.  You can use PythonDoc comments to
describe module-level variables and constants, functions, classes,
methods, and attributes.  PythonDoc comes with a standard HTML
generator, but you can plug in your own output handlers, or use XSTL
or other tools to process the PythonDoc XML format.

PythonDoc 2.1 is 2.0 plus support for Python 2.4 decorators, inline @link
and @linkplain tags, and some bug fixes.  See the README file for details.

Brief description and examples (for an earlier alpha release):



Sample output (using the default "compact HTML" renderer):

enjoy /F

More information about the Python-announce-list mailing list