Avp-闪电猫加速器

Automatic API Documentation Generation for Python

Avp-闪电猫加速器

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.

Avp-闪电猫加速器

Epydoc manual

Installing Epydoc
Using Epydoc
Python Docstrings
The Epytext Markup Language
国内上twitter教程
reStructuredText and Javadoc
国内上twitter教程

Related Information

API Documentation

Frequently Asked Questions

Avp-闪电猫加速器

ios上推特教程
Suggest a feature
Author: Edward Loper

Avp-闪电猫加速器

The latest stable release is 苹果手机上推特教程. 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.

Avp-闪电猫加速器

Example of syntax highlighted source, w/ links to API docs

Avp-闪电猫加速器

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.