ANN: PythonDoc 2.0 final (november 3, 2003)
Fredrik Lundh
fredrik@pythonware.com
Sat, 8 Nov 2003 11:49:50 +0100
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.
Compared to the last beta, PythonDoc 2.0 final adds support for RISC
OS (and similar platforms) and support for module-level comments.
Downloads:
http://effbot.org/downloads#pythondoc
http://effbot.org/downloads#elementtree
Documentation:
http://effbot.org/zone/pythondoc.htm
Brief description and examples (for an earlier alpha release):
http://online.effbot.org/2003_10_01_archive.htm#pythondoc-20a1
Sample output (using the built-in "compact HTML" renderer):
http://effbot.org/zone/pythondoc-compact.htm
http://effbot.org/zone/element-api.htm
enjoy /F