|
|
| [show private | hide private] |
Author: Edward Loper
Automatic Python reference documentation generator. Epydoc processes Python modules and docstrings to generate formatted API documentation, in the form of HTML pages. Epydoc can be used via a command-line interface (epydoc.cli) and a
graphical interface (epydoc.gui). Both interfaces let the user
specify a set of modules to document, and produce API documentation using
the following steps:
epydoc.imports.
epydoc.objdoc. epydoc.uid is used to
create unique identifiers for each object, and epydoc.epytext is
used to parse the objects' docstrings.
epydoc.html. epydoc.css and epydoc.help are used to generate the CSS
stylesheet and the help file.
cli: Command-line interface for epydoc.
gui: Graphical interface to epydoc.
imports: Module import support for epydoc.
objdoc: Support for ObjDocs, which encode the information about a Python object that is necessary to create its documentation.
epytext: Parser for epytext strings.
uid: Unique identifiers and crossreference links for Python objects.
html: Documentation to HTML converter.
css: Predefined CSS stylesheets for the HTML outputter (epydoc.html).
checker: Documentation completeness checker.
help: Predefined help file for the HTML outputter (epydoc.html).
|
|
| Generated by Epydoc on Sun Oct 6 03:32:10 2002 | http://epydoc.sf.net |