What's New in Epydoc

Epydoc 3.0

Released January, 2008

Support for Parsing & Introspection

In previous versions, epydoc extracted information about each module by importing it, and using introspection to examine its contents. Epydoc 3.0 still supports introspection, but is also capable of extracting information about python modules by parsing their source code. Furthermore, the new version of epydoc can combine these two sources of information (introspection & parsing). This is important because each source has its own advantages and disadvantages with respect to the other. See the FAQ for more information about the relative benefits of introspection and parsing, and why it's good to merge information from both sources.

Docstrings for variables

Epydoc now supports variable docstrings. If a variable assignment statement is immediately followed by a bare string literal, then that assignment is treated as a docstring for that variable. In classes, variable assignments at the class definition level are considered class variables; and assignments to instance variables in the constructor (__init__) are considered instance variables:

>>> class A:
...     x = 22
...     """Docstring for class variable A.x"""
...     def __init__(self, a):
...         self.y = a
...         """Docstring for instance variable A.y

Variables may also be documented using comment docstrings. If a variable assignment is immediately preceeded by a comment whose lines begin with the special marker "#:", or is followed on the same line by such a comment, then it is treated as a docstring for that variable:

>>> #: docstring for x
... x = 22
>>> x = 22 #: docstring for x

Graphs & Diagrams

Epydoc can automatically generate a variety of graphs, including class tress, package trees, uml class graphs, and import graphs. These graphs may be included in the generated output in one of two ways:

Epydoc can also generate function call graphs, showing the callers and the callees for each function. To generate call graphs, Epydoc uses data produced by a Python profiler such Profile or hotshot.

For some examples of automatically generated graphs, see the API Documentation for epydoc (including the page for the epydoc.docwriter.dotgraph module).

Graph generation requires the Graphviz package [download].

Syntax Highlighted Source Code

The HTML output now includes source code listings with syntax higlighting, including links from identifiers back into the documentation. For examples of source code pages, see the API Documentation for epydoc (follow the show source link from any documented module, class, or function).

Improved Output

Improved Documentation Extraction

Epydoc 2.1

Released March 20, 2004

New Features

Epydoc 2.0

Released July 22, 2003

New Features

Improvements to Docstring processing Improvements to Output Generation Improvements to Inspection Improvements to Efficiency


Older Releases

See the Release Notes on SourceForge.