ANN: PythonDoc 2.0 beta 3 (october 26, 2003)
(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): http://online.effbot.org/2003_10_01_archive.htm#pythondoc-20a1 Downloads: http://effbot.org/downloads#pythondoc http://effbot.org/downloads#elementtree Documentation: http://effbot.org/zone/pythondoc.htm Sample output (using the default "compact HTML" renderer): http://effbot.org/zone/pythondoc-compact.htm enjoy /F
participants (1)
-
Fredrik Lundh