Epydoc

Overview

Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. For an example of epydoc's output, see the API documentation for epydoc itself (html, pdf). A lightweight markup language called epytext can be used to format docstrings, and to add information about specific fields, such as parameters and instance variables. Epydoc also understands docstrings written in ReStructuredText, Javadoc, and plaintext. For a more extensive example of epydoc's output, see the API documentation for Python 2.4.

News

Epydoc 3.0 alpha released [March 2006]
An alpha release of epydoc 3.0 is now available on the SourceForge download page. See the What's New page for details. Epydoc is under active development; if you wish to keep up on the latest developments, you get epydoc from the subversion repository. If you find any bugs, or have suggestions for improving it, please report them on sourceforge.

Presentation at PyCon [March 2004]
Epydoc was presented at PyCon by Edward Loper. Video and audio from the presentation are available for download.

Documentation

Using Epydoc

• Installing Epydoc
• Using Epydoc
• Frequently Asked Questions
• API Documentation

Docstring Markup

• Python Docstrings
• Introduction to Epytext Markup
• Epytext Markup Language Manual
• ReStructuredText and Javadoc
• Epydoc Fields

Related Information

• Open Source License
• Change Log
• History
• Future Directions
• Related Projects

Latest Release

The latest stable release of epydoc (version 2.1) can be downloaded from the SourceForge download page. See Installing Epydoc for more information.