ANN: PythonDoc 2.0 beta 3 (october 26, 2003)

Fredrik Lundh
Sun, 26 Oct 2003 10:04:35 +0100

(aka PythonDoc 2.0 release candidate 1)

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 2.0 is a complete rewrite of my xmltoys/PythonDoc tool
from last year.  The new version uses a much improved parser (based
on source code scanning rather than introspection), and is designed
to work with Python 1.5.2 and later.

PythonDoc 2.0 beta 3 provides limited support for additional JavaDoc
tags (@author, @version, etc), uses a slightly modified XML format,
works with ElementTree 1.0, supports filename wildcards on Windows,
and only writes XML files if you use the -x option.

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



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

enjoy /F