[hide private]
[frames] | no frames]

[ Module Hierarchy | Class Hierarchy ]

# 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.docwriter.xlink: A Docutils interpreted text role for cross-API reference support.
  - 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.doctest: Syntax highlighting for doctest blocks.
    - epydoc.markup.epytext: Parser for epytext strings.
    - epydoc.markup.javadoc: Epydoc parser for Javadoc docstrings.
    - epydoc.markup.plaintext: Parser for plaintext docstrings.
    - epydoc.markup.pyval_repr: Syntax highlighter for Python values.
    - epydoc.markup.restructuredtext: Epydoc parser for ReStructuredText strings.
  - epydoc.test: Regression testing.
    - epydoc.test.util: Utility functions used by the regression tests (`*.doctest`).
  - epydoc.util: Miscellaneous utility functions that are used by multiple modules.