[hide private]
[frames] | no frames]

[ Module Hierarchy | Class Hierarchy ]

# Class Hierarchy

- docutils.nodes.Body
  - docutils.nodes.General
    - docutils.nodes.image
      - epydoc.markup.restructuredtext.dotgraph: A custom docutils node that should be rendered using Graphviz dot.
- epydoc.docbuilder.BuildOptions: Holds the parameters for a documentation building process.
- epydoc.markup.ConcatenatedDocstring
- epydoc.checker.DocChecker: Documentation completeness checker.
- epydoc.apidoc.DocIndex: [xx] out of date.
- 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.markup.DocstringLinker: A translator for crossreference links into and out of a `ParsedDocstring`.
  - epydoc.docwriter.html._HTMLDocstringLinker
  - epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker
- epydoc.markup.doctest.DoctestColorizer: An abstract base class for performing syntax highlighting on doctest blocks and other bits of Python code.
  - epydoc.markup.doctest.HTMLDoctestColorizer: A subclass of DoctestColorizer that generates HTML output.
  - epydoc.markup.doctest.LaTeXDoctestColorizer: A subclass of DoctestColorizer that generates LaTeX output.
  - epydoc.markup.doctest.XMLDoctestColorizer: A subclass of DoctestColorizer that generates XML-like output.
- epydoc.docwriter.dotgraph.DotGraph: A `dot` directed graph.
- epydoc.docwriter.dotgraph.DotGraphEdge
- epydoc.docwriter.dotgraph.DotGraphNode
  - epydoc.docwriter.dotgraph.DotGraphUmlClassNode: A specialized dot graph node used to display ClassDocs using UML notation.
  - epydoc.docwriter.dotgraph.DotGraphUmlModuleNode: A specialized dot grah node used to display ModuleDocs using UML notation.
- epydoc.apidoc.DottedName: A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument.
- epydoc.markup.epytext.Element: A very simple DOM-like representation for parsed epytext documents.
- epydoc.gui.EpydocGUI: A graphical user interace to epydoc.
- 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.
  - epydoc.docparser.ParseError: An exception that is used to signify that `docparser` encountered syntactically invalid Python code while processing a Python source file.
  - exceptions.StandardError: Base class for all standard Python exceptions.
    - exceptions.EnvironmentError: Base class for I/O related errors.
      - exceptions.OSError: OS system call failed.
        - epydoc.util.RunSubprocessError
    - exceptions.LookupError: Base class for lookup errors.
      - exceptions.IndexError: Sequence index out of range.
        - epydoc.docwriter.xlink.UrlGenerator.IndexAmbiguous: The name looked for is ambiguous
    - 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.
  - epydoc.markup.pyval_repr._Linebreak: A control-flow exception that is raised when PyvalColorizer generates a string containing a newline, but the state object's linebreakok variable is False.
  - epydoc.markup.pyval_repr._Maxlines: A control-flow exception that is raised when PyvalColorizer exeeds the maximum number of allowed lines.
- epydoc.markup.Field: The contents of a docstring's field.
- epydoc.docwriter.html.HTMLWriter
- docutils.nodes.Inline
  - docutils.nodes.image
    - epydoc.markup.restructuredtext.dotgraph: A custom docutils node that should be rendered using Graphviz dot.
- epydoc.docwriter.latex.LatexWriter
- 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.cli.ConsoleLogger
    - epydoc.cli.UnifiedProgressConsoleLogger
  - epydoc.gui.GUILogger
  - epydoc.cli.HTMLLogger: A logger used to generate a log of all warnings and messages to an HTML file.
  - epydoc.log.SimpleLogger
- 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.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.
  - docutils.writers.html4css1.HTMLTranslator: This HTML writer has been optimized to produce visually compact lists (less vertical whitespace).
    - epydoc.markup.restructuredtext._EpydocHTMLTranslator
  - docutils.writers.latex2e.LaTeXTranslator
    - epydoc.markup.restructuredtext._EpydocLaTeXTranslator
  - 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.markup.restructuredtext._TermsExtractor: A docutils node visitor that extracts the terms from documentation.
- epydoc.markup.ParsedDocstring: A standard intermediate representation for parsed docstrings that can be used to generate output.
  - epydoc.markup.epytext.ParsedEpytextDocstring
    - epydoc.markup.pyval_repr.ColorizedPyvalRepr
  - 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.docwriter.plaintext.PlaintextWriter
- epydoc.docwriter.html_colorize.PythonSourceColorizer: A class that renders a python module's source code into HTML pages.
- epydoc.markup.pyval_repr.PyvalColorizer: Syntax highlighter for Python values.
- docutils.utils.Reporter: Info/warning/error reporter and `system_message` element generator.
  - epydoc.markup.restructuredtext.OptimizedReporter: A reporter that ignores all debug messages.
- 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.docwriter.xlink.ApiLinkReader: A Docutils standalone reader allowing external documentation links.
          - 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.
- epydoc.cli.TerminalController: A class that can be used to portably generate formatted output to a terminal.
- epydoc.markup.epytext.Token: `Token`s are an intermediate data structure used while constructing the structuring DOM tree for a formatted docstring.
- 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.docwriter.xlink.ApiLinkReader: A Docutils standalone reader allowing external documentation links.
          - 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.
- epydoc.docwriter.xlink.UrlGenerator: Generate URL from an object name.
  - epydoc.docwriter.xlink.DocUrlGenerator: Read a documentation index and generate URL's for it.
  - epydoc.docwriter.xlink.VoidUrlGenerator: Don't actually know any url, but don't report any error.
- epydoc.markup.pyval_repr._ColorizerState: An object uesd to keep track of the current state of the pyval colorizer.
- epydoc.docintrospecter._DevNull: A "file-like" object that discards anything that is written and always reports end-of-file when read.
- epydoc.docbuilder._ProgressEstimator: Used to keep track of progress when generating the initial docs for the given items.
- epydoc.apidoc._Sentinel: A unique value that won't compare equal to any other value.
- object: The most base type
  - epydoc.apidoc.APIDoc: API documentation information for a single element of a Python program.
    - epydoc.apidoc.ValueDoc: API documentation information about a single Python value.
      - 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.ClassDoc: API documentation information about a single class.
        - epydoc.apidoc.ModuleDoc: API documentation information about a single module.
      - epydoc.apidoc.PropertyDoc: API documentation information about a single property.
      - epydoc.apidoc.RoutineDoc: API documentation information about a single routine.
        - epydoc.apidoc.ClassMethodDoc
        - epydoc.apidoc.StaticMethodDoc
    - epydoc.apidoc.VariableDoc: API documentation information about a single Python variable.