pydoctor
- PyDoctor, an API documentation generator for Python libraries.astbuilder
- Convert ASTs into pydoctor.model.Documentable
instances.astutils
- Various bits of reusable code related to ast.AST
node 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 of docutils
nodes.markup
- Markup language support for docstrings. Each submodule defines a parser for a single markup language. These parsers convert an object's docstring to a ParsedDocstring
, 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 between pydoctor.epydoc.markup.numpy
and pydoctor.epydoc.markup.google
._pyval_repr
- Syntax highlighter for Python values. Currently provides special colorization support for:_types
- Render types from docutils.nodes.document
objects.sre_parse36
- Internal support module for sreepydoc2stan
- Convert pydoctor.epydoc
parsed markup into renderable content.extensions
- Pydoctor's extension system.attrs
- Support for attrs
.deprecate
- Support for twisted.python.deprecate
.zopeinterface
- Support for Zope interfaces.factory
- Create customizable model classes.linker
- This module provides implementations of epydoc's DocstringLinker
class.model
- Core pydoctor objects.mro
- C3 linearization algorithm.napoleon
- Convert docstrings from numpy or google style format to reST.node2stan
- Helper function to convert docutils
nodes to Stan tree.options
- The command-line parsing.qnmatch
- Provides a modified fnmatch
function 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 turn Documentable
instances into objects we can render.attributechild
- Undocumentedfunctionchild
- Undocumentedsidebar
- Classes for the sidebar generation.table
- Undocumentedsearch
- 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.test
- PyDoctor's test suite.epydoc
- No package docstring; 0/1 function, 2/7 modules documentedtest_epytext
- No module docstring; 1/6 function documentedtest_epytext2html
- Test how epytext is transformed to HTML using ParsedDocstring.to_node()
and node2stan.node2stan()
functions.test_epytext2node
- No module docstring; 1/1 function documentedtest_google_numpy
- Undocumentedtest_parsed_docstrings
- Test generic features of ParsedDocstring.test_pyval_repr
- No module docstring; 16/56 functions documentedtest_restructuredtext
- No module docstring; 6/19 functions documentedtest_astbuilder
- No module docstring; 0/1 variable, 47/94 functions, 4/5 classes documentedtest_attrs
- No module docstring; 0/1 variable, 5/5 functions documentedtest_colorize
- Undocumentedtest_commandline
- No module docstring; 16/20 functions documentedtest_configparser
- Undocumentedtest_cyclic_imports_base_classes
- This test case is in its own file because it requires the PYTHONHASHSEED=0 environment variable. See issue #482.test_epydoc2stan
- No module docstring; 46/63 functions, 3/3 classes documentedtest_model
- Unit tests for model.test_mro
- No module docstring; 1/6 function documentedtest_napoleon_docstring
- Forked from the tests for sphinx.ext.napoleon.docstring module. :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details.test_napoleon_iterators
- Tests for pydoctor.napoleon.iterators
module.test_node2stan
- Tests for the node2stan
module.test_options
- Undocumentedtest_packages
- No module docstring; 0/1 variable, 6/12 functions documentedtest_pydantic_fields
- Undocumentedtest_qnmatch
- Undocumentedtest_sphinx
- Tests for Sphinx integration.test_templatewriter
- No module docstring; 0/2 variable, 10/36 functions documentedtest_twisted_python_deprecate
- No module docstring; 0/3 variable, 3/4 functions documentedtest_type_fields
- No module docstring; 3/13 functions documentedtest_utils
- Undocumentedtest_visitor
- Undocumentedtest_zopeinterface
- No module docstring; 0/1 variable, 9/27 functions documentedthemes
- Package directory used to store pydoctor templates.utils
- General purpose utility functions.visitor
- General purpose visitor pattern implementation, with extensions.__main__
- Undocumented_configparser
- Useful extension to configargparse
config file parsers.