| Home | Trees | Index | Help |
|
|---|
|
epydoc: Automatic Python reference documentation generator.
cli: Command-line interface for epydoc.
gui: Graphical interface to epydoc.
uid: Unique identifiers and crossreference links for Python objects.
objdoc: Support for ObjDocs, which encode the information about a
Python object that is necessary to create its documentation.
imports: Module import support for epydoc.
markup: Markup language support for docstrings.
epytext: Parser for epytext strings.
javadoc: Epydoc parser for Javadoc docstrings.
plaintext: Parser for plaintext docstrings.
restructuredtext: Epydoc parser for ReStructuredText strings.
html: Documentation to HTML converter.
css: Predefined CSS stylesheets for the HTML outputter (epydoc.html).
help: Default help file for the HTML outputter (epydoc.html).
colorize: Functions to produce colorized HTML code for various objects.
latex: Documentation to LaTeX converter.
man: Documentation formatter that produces man-style documentation.
checker: Documentation completeness checker.
test: Unit tests for the NLTK modules.
epytext: Regression testing for the epytext markup language.
foog
UserDict.UserDict
epydoc.objdoc.DocMap:
A dictionary mapping each object to the object's documentation.
docutils.SettingsSpec:
Runtime setting specification base class.
docutils.Component:
Base class for Docutils components.
docutils.readers.Reader:
Abstract base class for docutils Readers.
docutils.readers.standalone.Reader
epydoc.markup.restructuredtext._EpydocReader:
A reader that captures all errors that are generated by parsing, and
appends them to a list.
docutils.writers.Writer:
Abstract base class for docutils Writers.
epydoc.markup.restructuredtext._DocumentPseudoWriter:
A pseudo-writer for the docutils framework, that can be used to access
the document itself.
docutils.TransformSpec:
Runtime transform specification base class.
docutils.Component:
Base class for Docutils components.
docutils.readers.Reader:
Abstract base class for docutils Readers.
docutils.readers.standalone.Reader
epydoc.markup.restructuredtext._EpydocReader:
A reader that captures all errors that are generated by parsing, and
appends them to a list.
docutils.writers.Writer:
Abstract base class for docutils Writers.
epydoc.markup.restructuredtext._DocumentPseudoWriter:
A pseudo-writer for the docutils framework, that can be used to access
the document itself.
docutils.nodes.NodeVisitor:
"Visitor" pattern [GoF95] abstract superclass implementation for document
tree traversals.
docutils.writers.html4css1.HTMLTranslator:
This HTML writer has been optimized to produce visually compact
lists (less vertical whitespace).
epydoc.markup.restructuredtext._SplitFieldsTranslator:
A docutils translator that removes all fields from a document, and
collects them into the instance variable fields
epydoc.markup.restructuredtext._SummaryExtractor:
A docutils node visitor that extracts the first sentence from the
first paragraph in a document.
epydoc.checker.DocChecker:
Documentation completeness checker.
epydoc.cli._Progress:
The progress meter that is used by cli to report its
progress.
epydoc.foog.Foo
epydoc.gui.EpydocGUI:
A graphical user interace to epydoc.
epydoc.gui._PipeIO:
A file-like class that captures strings and prints them.
epydoc.html.HTMLFormatter:
Documentation to HTML converter.
epydoc.html._DevNull:
A file-like-object that ignores all input.
epydoc.imports._DevNull:
A "file-like" object that discards anything that is written
and always reports end-of-file when read.
epydoc.latex.LatexFormatter:
Documentation to LaTeX converter.
epydoc.man.ManFormatter
epydoc.markup.DocstringLinker:
A translator for crossreference links into and out of a
ParsedDocstring.
epydoc.markup.Field:
The contents of a docstring's field.
epydoc.markup.ParsedDocstring:
A standard intermediate representation for parsed docstrings that can
be used to generate output.
epydoc.markup.epytext.ParsedEpytextDocstring
epydoc.markup.javadoc.ParsedJavadocDocstring:
An encoded version of a Javadoc docstring.
epydoc.markup.plaintext.ParsedPlaintextDocstring
epydoc.markup.restructuredtext.ParsedRstDocstring:
An encoded version of a ReStructuredText docstring.
epydoc.markup.epytext.Token:
Tokens are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring.
epydoc.objdoc.DocField:
A generic docstring field.
epydoc.objdoc.ObjDoc:
A base class for encoding the information about a Python object that
is necessary to create its documentation.
epydoc.objdoc.ClassDoc:
The documentation for a class.
epydoc.objdoc.FuncDoc:
The documentation for a function.
epydoc.objdoc.ModuleDoc:
The documentation for a module or package.
epydoc.objdoc.PropertyDoc:
The documentation for a property.
epydoc.objdoc.Param:
The documentation for a function parameter.
epydoc.objdoc.Raise:
The documentation for the raising of an exception.
epydoc.objdoc.Var:
The documentation for a variable.
epydoc.uid.Link:
A cross-reference link between documentation.
epydoc.uid.UID:
A globally unique identifier.
epydoc.uid.ObjectUID:
A globally unique identifier used to refer to a Python object.
epydoc.uid.RelativeUID:
A globally unique identifier used to refer to a variable, relative to
a Python object.
exceptions.Exception:
Common base class for all exceptions.
epydoc.markup.ParseError:
The base class for errors generated while parsing docstrings.
epydoc.markup.epytext.ColorizingError:
An error generated while colorizing a paragraph.
epydoc.markup.epytext.StructuringError:
An error generated while structuring a formatted documentation
string.
epydoc.markup.epytext.TokenizationError:
An error generated while tokenizing a formatted documentation
string.
exceptions.StandardError:
Base class for all standard Python exceptions.
exceptions.AssertionError:
Assertion failed.
unittest.TestCase:
A class whose instances are single test cases.
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:23 2004 | http://epydoc.sf.net |