Module Index
pydoctor- PyDoctor, an API documentation generator for Python libraries.astbuilder- Convert ASTs intopydoctor.model.Documentableinstances.astutils- Various bits of reusable code related toast.ASTnode processing.driver- The entry point.epydoc- epydoc is an automatic Python reference documentation generator. pydoctor uses parts of the epydoc source as a library.doctest- Syntax highlighting for blocks of Python code.docutils- Collection of helper functions and classes related to the creation and processing ofdocutilsnodes.markup- Markup language support for docstrings. Each submodule defines a parser for a single markup language. These parsers convert an object's docstring to aParsedDocstring, a standard intermediate representation that can be used to generate output.epytext- Parser for epytext strings. Epytext is a lightweight markup whose primary intended application is Python documentation strings. This parser converts Epytext strings to a simple DOM-like representation (encoded as a tree of ...google- Parser for google-style docstrings.numpy- Parser for numpy-style docstrings.plaintext- Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.restructuredtext- Epydoc parser for ReStructuredText strings. ReStructuredText is the standard markup language used by the Docutils project.parse_docstring()provides the primary interface to this module; it returns a ..._napoleon- This module contains a class to wrap shared behaviour betweenpydoctor.epydoc.markup.numpyandpydoctor.epydoc.markup.google._pyval_repr- Syntax highlighter for Python values. Currently provides special colorization support for:_types- Render types fromdocutils.nodes.documentobjects.
sre_constants36- Internal support module for sresre_parse36- Internal support module for sre
epydoc2stan- Convertpydoctor.epydocparsed markup into renderable content.extensions- Pydoctor's extension system.attrs- Support forattrs.deprecate- Support fortwisted.python.deprecate.zopeinterface- Support for Zope interfaces.
factory- Create customizable model classes.linker- This module provides implementations of epydoc'sDocstringLinkerclass.model- Core pydoctor objects.mro- C3 linearization algorithm.napoleon- Convert docstrings from numpy or google style format to reST.node2stan- Helper function to convertdocutilsnodes to Stan tree.options- The command-line parsing.qnmatch- Provides a modifiedfnmatchfunction specialized for python objects fully qualified name pattern matching.sphinx- Support for Sphinx compatibility.sphinx_ext- Public and private extensions for Sphinx.build_apidocs- Generate the API docs using pydoctor to be integrated into Sphinx build system.
stanutils- Utilities related to Stan tree building and HTML flattening.templatewriter- Render pydoctor data as HTML.pages- The classes that turnDocumentableinstances into objects we can render.attributechild- Undocumentedfunctionchild- Undocumentedsidebar- Classes for the sidebar generation.table- Undocumented
search- Code building ``all-documents.html``, ``searchindex.json`` and ``fullsearchindex.json``.summary- Classes that generate the summary pages.util- Miscellaneous utilities for the HTML writer.writer- Badly named module that contains the driving code for the rendering.
themes- Package directory used to store pydoctor templates.tokenutils- No module docstring; 0/2 variable, 2/2 functions, 3/3 classes documentedutils- General purpose utility functions.visitor- General purpose visitor pattern implementation, with extensions.__main__- Undocumented_configparser- Useful extension toconfigargparseconfig file parsers.