[Doc-SIG] epydoc 2.0 released

Edward Loper edloper at gradient.cis.upenn.edu
Tue Jul 22 02:43:11 EDT 2003

I just released version 2.0 of epydoc.  Of special note to some of the
members in this list is the fact that it supports ReStructuredText. :)

Epydoc is a tool for generating API documentation for Python modules,
based on their docstrings.


For some examples of the documentation generated by epydoc, see:

   - The API documentation for epydoc. (HTML)

   - The API documentation for epydoc. (PDF)

   - The API documentation for the Python 2.2 standard library.

   - The API documentation for NLTK, the natural langauge toolkit.

   - The API documentation for Docutils

Epydoc currently understands four markup languages:
   - Epytext, a lightweight markup language with support for basic
     formatting constructs.
   - ReStructuredText, an "easy-to-read, what-you-see-is-what-you-get
     plaintext markup syntax."
   - Javadoc, the standard markup language for documenting java source.
   - Plaintext.

New features added since 1.1 include:

   Improvements to Docstring processing
     - Support for ReStructuredText docstrings.
     - Support for Javadoc docstrings.
     - Many new documentation fields for docstrings.
     - More robust crossreference link resolving.

   Improvements to Output Generation
     - New output formats: LaTeX, DVI, PostScript, and PDF.
     - Three new formats for displaying inherited methods and
       variables: listed, grouped, and included.

   Improvements to Inspection
     - Support for new Python 2.2+ objects, including class methods,
       static methods, properties, and metaclasses.
     - Automatic detection of imported variables.
     - Documentation inheritance for inherited methods and variables.

   Improvements to Efficiency
     - Epydoc 2.0 runs 50%-200% faster than epydoc 1.1.  (e.g., it
       runs 2.6 times as fast when documenting the Python standard

A complete list of new features and the change log are available at:



More information about the Doc-SIG mailing list