Module Hierarchy

• epydoc: Automatic Python reference documentation generator.
• epydoc.apidoc: Classes for encoding API documentation about Python programs.
• epydoc.checker: Documentation completeness checker.
• epydoc.cli: Command-line interface for epydoc.
• epydoc.compat: Backwards compatibility with previous versions of Python.
• epydoc.docbuilder: Construct data structures that encode the API documentation for Python objects.
• epydoc.docintrospecter: Extract API documentation about python objects by directly introspecting their values.
• epydoc.docparser: Extract API documentation about python objects by parsing their source code.
• epydoc.docstringparser: Parse docstrings and handle any fields it defines, such as @type and @author.
• epydoc.docwriter: Output generation.
• epydoc.docwriter.dotgraph: Render Graphviz directed graphs as images.
• epydoc.docwriter.html: The HTML output generator for epydoc.
• epydoc.docwriter.html_colorize: Functions to produce colorized HTML code for various objects.
• epydoc.docwriter.html_css: Predefined CSS stylesheets for the HTML outputter (epydoc.docwriter.html).
• epydoc.docwriter.html_help: Default help file for the HTML outputter (epydoc.docwriter.html).
• epydoc.docwriter.latex: The LaTeX output generator for epydoc.
• epydoc.docwriter.plaintext: Plaintext output generation.
• epydoc.gui: Graphical interface to epydoc.
• epydoc.log: Functions used to report messages and progress updates to the user.
• epydoc.markup: Markup language support for docstrings.
• epydoc.markup.epytext: Parser for epytext strings.
• epydoc.markup.javadoc: Epydoc parser for Javadoc docstrings.
• epydoc.markup.plaintext: Parser for plaintext docstrings.
• epydoc.markup.restructuredtext: Epydoc parser for ReStructuredText strings.
• epydoc.test: Regression testing.
• epydoc.util: Miscellaneous utility functions that are used by multiple modules.

Class Hierarchy

• 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.Body
  • docutils.nodes.General
    • docutils.nodes.image
      • epydoc.markup.restructuredtext.dotgraph: A custom docutils node that should be rendered using Graphviz dot.
• docutils.nodes.Inline
  • docutils.nodes.image
    • epydoc.markup.restructuredtext.dotgraph: A custom docutils node that should be rendered using Graphviz dot.
• docutils.nodes.Node: Abstract base class of nodes in a document tree.
  • docutils.nodes.Element: Element is the superclass to all specific elements.
    • docutils.nodes.TextElement: An element which directly contains text.
      • docutils.nodes.image
        • epydoc.markup.restructuredtext.dotgraph: A custom docutils node that should be rendered using Graphviz dot.
• docutils.nodes.NodeVisitor: "Visitor" pattern [GoF95] abstract superclass implementation for document tree traversals.
  • epydoc.markup.restructuredtext._SplitFieldsTranslator: A docutils translator that removes all fields from a document, and collects them into the instance variable fields
  • docutils.writers.latex2e.LaTeXTranslator
    • epydoc.markup.restructuredtext._EpydocLaTeXTranslator
  • docutils.writers.html4css1.HTMLTranslator: This HTML writer has been optimized to produce visually compact lists (less vertical whitespace).
    • epydoc.markup.restructuredtext._EpydocHTMLTranslator
  • epydoc.markup.restructuredtext._SummaryExtractor: A docutils node visitor that extracts the first sentence from the first paragraph in a document.
• epydoc.apidoc.DocIndex: [xx] out of date.
• epydoc.apidoc.DottedName: A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument.
• epydoc.apidoc._Sentinel: A unique value that won't compare equal to any other value.
• epydoc.checker.DocChecker: Documentation completeness checker.
• epydoc.cli.TerminalController: A class that can be used to portably generate formatted output to a terminal.
• epydoc.docbuilder._ProgressEstimator: Used to keep track of progress when generating the initial docs for the given items.
• epydoc.docintrospecter._DevNull: A "file-like" object that discards anything that is written and always reports end-of-file when read.
• epydoc.docstringparser.DocstringField: A simple docstring field, which can be used to describe specific information about an object, such as its author or its version.
• epydoc.docwriter.dotgraph.DotGraph: A dot directed graph.
• epydoc.docwriter.dotgraph.DotGraphEdge
• epydoc.docwriter.dotgraph.DotGraphNode
  • epydoc.docwriter.dotgraph.DotGraphUmlModuleNode: A specialized dot grah node used to display ModuleDocs using UML notation.
  • epydoc.docwriter.dotgraph.DotGraphUmlClassNode: A specialized dot graph node used to display ClassDocs using UML notation.
• epydoc.docwriter.html.HTMLWriter
• epydoc.docwriter.html_colorize.PythonSourceColorizer: A class that renders a python module's source code into HTML pages.
• epydoc.docwriter.latex.LatexWriter
• epydoc.docwriter.plaintext.PlaintextWriter
• epydoc.gui.EpydocGUI: A graphical user interace to epydoc.
• epydoc.log.Logger: An abstract base class that defines the interface for loggers, which are used by epydoc to report information back to the user.
  • epydoc.gui.GUILogger
  • epydoc.cli.ConsoleLogger
    • epydoc.cli.UnifiedProgressConsoleLogger
  • epydoc.log.SimpleLogger
• epydoc.markup.ConcatenatedDocstring
• epydoc.markup.DocstringLinker: A translator for crossreference links into and out of a ParsedDocstring.
  • epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker
  • epydoc.docwriter.html._HTMLDocstringLinker
• 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.restructuredtext.ParsedRstDocstring: An encoded version of a ReStructuredText docstring.
  • epydoc.markup.javadoc.ParsedJavadocDocstring: An encoded version of a Javadoc docstring.
  • epydoc.markup.epytext.ParsedEpytextDocstring
  • epydoc.markup.plaintext.ParsedPlaintextDocstring
• epydoc.markup.epytext.Token: Tokens are an intermediate data structure used while constructing the structuring DOM tree for a formatted docstring.
• exceptions.Exception: Common base class for all exceptions.
  • exceptions.StandardError: Base class for all standard Python exceptions.
    • exceptions.ValueError: Inappropriate argument value (of correct type).
      • epydoc.apidoc.DottedName.InvalidDottedName: An exception raised by the DottedName constructor when one of its arguments is not a valid dotted name.
    • exceptions.EnvironmentError: Base class for I/O related errors.
      • exceptions.OSError: OS system call failed.
        • epydoc.util.RunSubprocessError
  • epydoc.markup.ParseError: The base class for errors generated while parsing docstrings.
    • epydoc.markup.epytext.StructuringError: An error generated while structuring a formatted documentation string.
    • epydoc.markup.epytext.ColorizingError: An error generated while colorizing a paragraph.
    • epydoc.markup.epytext.TokenizationError: An error generated while tokenizing a formatted documentation string.
  • epydoc.docparser.ParseError: An exception that is used to signify that docparser encountered syntactically invalid Python code while processing a Python source file.
• object: The most base type...
  • epydoc.apidoc.APIDoc: API documentation information for a single element of a Python program.
    • epydoc.apidoc.VariableDoc: API documentation information about a single Python variable.
    • epydoc.apidoc.ValueDoc: API documentation information about a single Python value.
      • epydoc.apidoc.RoutineDoc: API documentation information about a single routine.
        • epydoc.apidoc.StaticMethodDoc
        • epydoc.apidoc.ClassMethodDoc
      • epydoc.apidoc.GenericValueDoc: API documentation about a 'generic' value, i.e., one that does not have its own docstring or any information other than its value and parse representation.
      • epydoc.apidoc.NamespaceDoc: API documentation information about a singe Python namespace value.
        • epydoc.apidoc.ModuleDoc: API documentation information about a single module.
        • epydoc.apidoc.ClassDoc: API documentation information about a single class.
      • epydoc.apidoc.PropertyDoc: API documentation information about a single property.