Module Hierarchy

• epydoc: Automatic Python reference documentation generator.
  • 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).

Class Hierarchy

• UserDict.UserDict
  • epydoc.objdoc.DocMap: A dictionary mapping each object to the object's documentation.
• epydoc.checker.DocChecker: Documentation completeness checker.
• epydoc.epytext.Token: Tokens are an intermediate data structure used while constructing the structuring DOM tree for a formatted docstring.
• epydoc.gui.EpydocGUI: A graphical user interace to epydoc.
• epydoc.html.HTML_Doc: Documentation to HTML converter.
• 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 of method.
  • epydoc.objdoc.ModuleDoc: The documentation for a module or package.
• epydoc.objdoc.Raise: The documentation for the raising of an exception.
• epydoc.objdoc.Var: The documentation for an individual variable.
• epydoc.uid.Link: A cross-reference link between documentation.
• epydoc.uid.UID: A globally unique identifier used to refer to a Python object.
• exceptions.Exception: Common base class for all exceptions.
  • epydoc.epytext.ParseError: The base class for warnings and errors generated while parsing epytext strings.
    • epydoc.epytext.ColorizingError: A warning or error generated while colorizing a paragraph.
    • epydoc.epytext.StructuringError: A warning or error generated while structuring a formatted documentation string.
    • epydoc.epytext.TokenizationError: A warning or error generated while tokenizing a formatted documentation string.