# Epydoc

Automatic API Documentation Generation for Python

## 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.5.

## Documentation

Epydoc manual

- Installing Epydoc
- Using Epydoc
- Python Docstrings
- The Epytext Markup Language
- Epydoc Fields
- reStructuredText and Javadoc
- Reference Documentation

Related Information

- Open Source License
- Change Log
- History
- Future Directions
- Related Projects
- Regression Tests

API Documentation | Frequently Asked Questions

## Feedback

- Report a bug
- Suggest a feature

## Latest Release

The latest stable release is Epydoc 3.0. If you wish to keep up on the latest developments, you can also get epydoc from the subversion repository. See Installing Epydoc for more information.

## Screenshots

## News

Epydoc 3.0 released [January 2008]
Epydoc version 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 can 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.

Home