Metadata

Distro Index Owner:
eea
Home Page:
epydoc
License
IBM Open Source License
Version:
3.0.1-eea.3
Last updated:
2012-11-19
Keywords:
docstring

epydoc

Files

Indexes

Edward Loper's API Documentation Generation Tool

Epydoc is a tool for generating API documentation 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.