All Documents

• pydoctor
  index.html
  Package
  Package
  PUBLIC
  PyDoctor, an API documentation generator for Python libraries.
• pydoctor.__main__
  pydoctor.__main__.html
  Module
  Module
  PRIVATE
  Undocumented
• pydoctor._configparser
  pydoctor._configparser.html
  Module
  Module
  PRIVATE
  Useful extension to configargparse config file parsers.
• pydoctor.astbuilder
  pydoctor.astbuilder.html
  Module
  Module
  PUBLIC
  Convert ASTs into pydoctor.model.Documentable instances.
• pydoctor.astutils
  pydoctor.astutils.html
  Module
  Module
  PUBLIC
  Various bits of reusable code related to ast.AST node processing.
• pydoctor.driver
  pydoctor.driver.html
  Module
  Module
  PUBLIC
  The entry point.
• pydoctor.epydoc
  pydoctor.epydoc.html
  Package
  Package
  PUBLIC
  epydoc is an automatic Python reference documentation generator. pydoctor uses parts of the epydoc source as a library.
• pydoctor.epydoc.doctest
  pydoctor.epydoc.doctest.html
  Module
  Module
  PUBLIC
  Syntax highlighting for blocks of Python code.
• pydoctor.epydoc.docutils
  pydoctor.epydoc.docutils.html
  Module
  Module
  PUBLIC
  Collection of helper functions and classes related to the creation and processing of docutils nodes.
• pydoctor.epydoc.markup
  pydoctor.epydoc.markup.html
  Package
  Package
  PUBLIC
  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.
• pydoctor.epydoc.markup._napoleon
  pydoctor.epydoc.markup._napoleon.html
  Module
  Module
  PRIVATE
  This module contains a class to wrap shared behaviour between pydoctor.epydoc.markup.numpy and pydoctor.epydoc.markup.google.
• pydoctor.epydoc.markup._pyval_repr
  pydoctor.epydoc.markup._pyval_repr.html
  Module
  Module
  PRIVATE
  Syntax highlighter for Python values. Currently provides special colorization support for:
• pydoctor.epydoc.markup._types
  pydoctor.epydoc.markup._types.html
  Module
  Module
  PRIVATE
  Render types from docutils.nodes.document objects.
• pydoctor.epydoc.markup.epytext
  pydoctor.epydoc.markup.epytext.html
  Module
  Module
  PUBLIC
  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 ...
• pydoctor.epydoc.markup.google
  pydoctor.epydoc.markup.google.html
  Module
  Module
  PUBLIC
  Parser for google-style docstrings.
• pydoctor.epydoc.markup.numpy
  pydoctor.epydoc.markup.numpy.html
  Module
  Module
  PUBLIC
  Parser for numpy-style docstrings.
• pydoctor.epydoc.markup.plaintext
  pydoctor.epydoc.markup.plaintext.html
  Module
  Module
  PUBLIC
  Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.
• pydoctor.epydoc.markup.restructuredtext
  pydoctor.epydoc.markup.restructuredtext.html
  Module
  Module
  PUBLIC
  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 ...
• pydoctor.epydoc.sre_constants36
  pydoctor.epydoc.sre_constants36.html
  Module
  Module
  PUBLIC
  Internal support module for sre
• pydoctor.epydoc.sre_parse36
  pydoctor.epydoc.sre_parse36.html
  Module
  Module
  PUBLIC
  Internal support module for sre
• pydoctor.epydoc2stan
  pydoctor.epydoc2stan.html
  Module
  Module
  PUBLIC
  Convert pydoctor.epydoc parsed markup into renderable content.
• pydoctor.extensions
  pydoctor.extensions.html
  Package
  Package
  PUBLIC
  Pydoctor's extension system.
• pydoctor.extensions.attrs
  pydoctor.extensions.attrs.html
  Module
  Module
  PUBLIC
  Support for attrs.
• pydoctor.extensions.deprecate
  pydoctor.extensions.deprecate.html
  Module
  Module
  PUBLIC
  Support for twisted.python.deprecate.
• pydoctor.extensions.zopeinterface
  pydoctor.extensions.zopeinterface.html
  Module
  Module
  PUBLIC
  Support for Zope interfaces.
• pydoctor.factory
  pydoctor.factory.html
  Module
  Module
  PUBLIC
  Create customizable model classes.
• pydoctor.linker
  pydoctor.linker.html
  Module
  Module
  PUBLIC
  This module provides implementations of epydoc's DocstringLinker class.
• pydoctor.model
  pydoctor.model.html
  Module
  Module
  PUBLIC
  Core pydoctor objects.
• pydoctor.mro
  pydoctor.mro.html
  Module
  Module
  PUBLIC
  C3 linearization algorithm.
• pydoctor.napoleon
  pydoctor.napoleon.html
  Package
  Package
  PUBLIC
  Convert docstrings from numpy or google style format to reST.
• pydoctor.napoleon.docstring
  pydoctor.napoleon.docstring.html
  Module
  Module
  PUBLIC
  Classes for google-style and numpy-style docstring conversion.
• pydoctor.napoleon.iterators
  pydoctor.napoleon.iterators.html
  Module
  Module
  PUBLIC
  A collection of helpful iterators.
• pydoctor.node2stan
  pydoctor.node2stan.html
  Module
  Module
  PUBLIC
  Helper function to convert docutils nodes to Stan tree.
• pydoctor.options
  pydoctor.options.html
  Module
  Module
  PUBLIC
  The command-line parsing.
• pydoctor.qnmatch
  pydoctor.qnmatch.html
  Module
  Module
  PUBLIC
  Provides a modified fnmatch function specialized for python objects fully qualified name pattern matching.
• pydoctor.sphinx
  pydoctor.sphinx.html
  Module
  Module
  PUBLIC
  Support for Sphinx compatibility.
• pydoctor.sphinx_ext
  pydoctor.sphinx_ext.html
  Package
  Package
  PUBLIC
  Public and private extensions for Sphinx.
• pydoctor.sphinx_ext.build_apidocs
  pydoctor.sphinx_ext.build_apidocs.html
  Module
  Module
  PUBLIC
  Generate the API docs using pydoctor to be integrated into Sphinx build system.
• pydoctor.stanutils
  pydoctor.stanutils.html
  Module
  Module
  PUBLIC
  Utilities related to Stan tree building and HTML flattening.
• pydoctor.templatewriter
  pydoctor.templatewriter.html
  Package
  Package
  PUBLIC
  Render pydoctor data as HTML.
• pydoctor.templatewriter.pages
  pydoctor.templatewriter.pages.html
  Package
  Package
  PUBLIC
  The classes that turn Documentable instances into objects we can render.
• pydoctor.templatewriter.pages.attributechild
  pydoctor.templatewriter.pages.attributechild.html
  Module
  Module
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild
  pydoctor.templatewriter.pages.functionchild.html
  Module
  Module
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar
  pydoctor.templatewriter.pages.sidebar.html
  Module
  Module
  PUBLIC
  Classes for the sidebar generation.
• pydoctor.templatewriter.pages.table
  pydoctor.templatewriter.pages.table.html
  Module
  Module
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search
  pydoctor.templatewriter.search.html
  Module
  Module
  PUBLIC
  Code building ``all-documents.html``, ``searchindex.json`` and ``fullsearchindex.json``.
• pydoctor.templatewriter.summary
  pydoctor.templatewriter.summary.html
  Module
  Module
  PUBLIC
  Classes that generate the summary pages.
• pydoctor.templatewriter.util
  pydoctor.templatewriter.util.html
  Module
  Module
  PUBLIC
  Miscellaneous utilities for the HTML writer.
• pydoctor.templatewriter.writer
  pydoctor.templatewriter.writer.html
  Module
  Module
  PUBLIC
  Badly named module that contains the driving code for the rendering.
• pydoctor.themes
  pydoctor.themes.html
  Package
  Package
  PUBLIC
  Package directory used to store pydoctor templates.
• pydoctor.tokenutils
  pydoctor.tokenutils.html
  Module
  Module
  PUBLIC
  No module docstring; 0/2 variable, 2/2 functions, 3/3 classes documented
• pydoctor.utils
  pydoctor.utils.html
  Module
  Module
  PUBLIC
  General purpose utility functions.
• pydoctor.visitor
  pydoctor.visitor.html
  Module
  Module
  PUBLIC
  General purpose visitor pattern implementation, with extensions.
• pydoctor.__version__
  index.html#__version__
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.themes.get_themes
  pydoctor.themes.html#get_themes
  Function
  Function
  PUBLIC
  Get the list of the available themes.
• pydoctor.epydoc.docutils._DEFAULT_DOCUTILS_SETTINGS
  pydoctor.epydoc.docutils.html#_DEFAULT_DOCUTILS_SETTINGS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.docutils.new_document
  pydoctor.epydoc.docutils.html#new_document
  Function
  Function
  PUBLIC
  Create a new nodes.document using the provided settings or cached default settings.
• pydoctor.epydoc.docutils._set_nodes_parent
  pydoctor.epydoc.docutils.html#_set_nodes_parent
  Function
  Function
  PRIVATE
  Set the nodes.Node.parent attribute of the nodes to the defined parent.
• pydoctor.epydoc.docutils.TNode
  pydoctor.epydoc.docutils.html#TNode
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.docutils.set_node_attributes
  pydoctor.epydoc.docutils.html#set_node_attributes
  Function
  Function
  PUBLIC
  Set the attributes of a Node and return the modified node. This is required to manually construct a docutils document that is consistent.
• pydoctor.epydoc.docutils.build_table_of_content
  pydoctor.epydoc.docutils.html#build_table_of_content
  Function
  Function
  PUBLIC
  Simplified from docutils Contents transform.
• pydoctor.epydoc.docutils.get_lineno
  pydoctor.epydoc.docutils.html#get_lineno
  Function
  Function
  PUBLIC
  Get the 0-based line number for a docutils `nodes.title_reference`.
• pydoctor.epydoc.docutils.text_node
  pydoctor.epydoc.docutils.html#text_node
  Function
  Function
  PUBLIC
  Create an inline node with the given text and class.
• pydoctor.epydoc.docutils.wbr
  pydoctor.epydoc.docutils.wbr.html
  Class
  Class
  PUBLIC
  Word break opportunity.
• pydoctor.epydoc.docutils.wbr.__init__
  pydoctor.epydoc.docutils.wbr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.docutils.obj_reference
  pydoctor.epydoc.docutils.obj_reference.html
  Class
  Class
  PUBLIC
  A reference to a documentable object.
• pydoctor.epydoc.docutils.code
  pydoctor.epydoc.docutils.code.html
  Class
  Class
  PUBLIC
  Like a inline[class='literal'], but more elegant.
• pydoctor.epydoc.doctest._KEYWORDS
  pydoctor.epydoc.doctest.html#_KEYWORDS
  Attribute
  Constant
  PRIVATE
  A list of the names of all Python keywords.
• pydoctor.epydoc.doctest._BUILTINS
  pydoctor.epydoc.doctest.html#_BUILTINS
  Attribute
  Constant
  PRIVATE
  A list of all Python builtins.
• pydoctor.epydoc.doctest._KEYWORD_GRP
  pydoctor.epydoc.doctest.html#_KEYWORD_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches keywords.
• pydoctor.epydoc.doctest._BUILTIN_GRP
  pydoctor.epydoc.doctest.html#_BUILTIN_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches Python builtins.
• pydoctor.epydoc.doctest._STRING_GRP
  pydoctor.epydoc.doctest.html#_STRING_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches Python strings.
• pydoctor.epydoc.doctest._COMMENT_GRP
  pydoctor.epydoc.doctest.html#_COMMENT_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches Python comments.
• pydoctor.epydoc.doctest._PROMPT1_GRP
  pydoctor.epydoc.doctest.html#_PROMPT1_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches Python ">>>" prompts.
• pydoctor.epydoc.doctest._PROMPT2_GRP
  pydoctor.epydoc.doctest.html#_PROMPT2_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches Python "..." prompts.
• pydoctor.epydoc.doctest._DEFINE_GRP
  pydoctor.epydoc.doctest.html#_DEFINE_GRP
  Attribute
  Constant
  PRIVATE
  A regexp group that matches function and class definitions.
• pydoctor.epydoc.doctest.DEFINE_FUNC_RE
  pydoctor.epydoc.doctest.html#DEFINE_FUNC_RE
  Attribute
  Constant
  PUBLIC
  A regexp that decomposes function definitions.
• pydoctor.epydoc.doctest.PROMPT_RE
  pydoctor.epydoc.doctest.html#PROMPT_RE
  Attribute
  Constant
  PUBLIC
  A regexp that matches Python prompts
• pydoctor.epydoc.doctest.PROMPT2_RE
  pydoctor.epydoc.doctest.html#PROMPT2_RE
  Attribute
  Constant
  PUBLIC
  A regexp that matches Python "..." prompts.
• pydoctor.epydoc.doctest.EXCEPT_RE
  pydoctor.epydoc.doctest.html#EXCEPT_RE
  Attribute
  Constant
  PUBLIC
  A regexp that matches doctest exception blocks.
• pydoctor.epydoc.doctest.DOCTEST_DIRECTIVE_RE
  pydoctor.epydoc.doctest.html#DOCTEST_DIRECTIVE_RE
  Attribute
  Constant
  PUBLIC
  A regexp that matches doctest directives.
• pydoctor.epydoc.doctest.DOCTEST_RE
  pydoctor.epydoc.doctest.html#DOCTEST_RE
  Attribute
  Constant
  PUBLIC
  A regexp that matches all of the regions of a doctest block that should be colored.
• pydoctor.epydoc.doctest.DOCTEST_EXAMPLE_RE
  pydoctor.epydoc.doctest.html#DOCTEST_EXAMPLE_RE
  Attribute
  Constant
  PUBLIC
  This regular expression is used to find doctest examples in a string. This is copied from the standard Python doctest.py module (after the refactoring in Python 2.4+).
• pydoctor.epydoc.doctest.colorize_codeblock
  pydoctor.epydoc.doctest.html#colorize_codeblock
  Function
  Function
  PUBLIC
  Colorize a string containing only Python code. This method differs from colorize_doctest in that it will not search for doctest prompts when deciding how to colorize the string.
• pydoctor.epydoc.doctest.colorize_doctest
  pydoctor.epydoc.doctest.html#colorize_doctest
  Function
  Function
  PUBLIC
  Perform syntax highlighting on the given doctest string, and return the resulting HTML code.
• pydoctor.epydoc.doctest.colorize_doctest_body
  pydoctor.epydoc.doctest.html#colorize_doctest_body
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc.doctest.colorize_codeblock_body
  pydoctor.epydoc.doctest.html#colorize_codeblock_body
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc.doctest.subfunc
  pydoctor.epydoc.doctest.html#subfunc
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.stanutils._RE_CONTROL
  pydoctor.stanutils.html#_RE_CONTROL
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.stanutils.html2stan
  pydoctor.stanutils.html#html2stan
  Function
  Function
  PUBLIC
  Convert an HTML string to a Stan tree.
• pydoctor.stanutils.flatten
  pydoctor.stanutils.html#flatten
  Function
  Function
  PUBLIC
  Convert a document fragment from a Stan tree to HTML.
• pydoctor.stanutils.flatten_text
  pydoctor.stanutils.html#flatten_text
  Function
  Function
  PUBLIC
  Return the text inside a stan tree.
• pydoctor.node2stan.node2html
  pydoctor.node2stan.html#node2html
  Function
  Function
  PUBLIC
  Convert a docutils.nodes.Node object to HTML strings.
• pydoctor.node2stan.node2stan
  pydoctor.node2stan.html#node2stan
  Function
  Function
  PUBLIC
  Convert docutils.nodes.Node objects to a Stan tree.
• pydoctor.node2stan.gettext
  pydoctor.node2stan.html#gettext
  Function
  Function
  PUBLIC
  Return the text inside the node(s).
• pydoctor.node2stan._TARGET_RE
  pydoctor.node2stan.html#_TARGET_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.node2stan._VALID_IDENTIFIER_RE
  pydoctor.node2stan.html#_VALID_IDENTIFIER_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.node2stan._valid_identifier
  pydoctor.node2stan.html#_valid_identifier
  Function
  Function
  PRIVATE
  Remove invalid characters to create valid CSS identifiers.
• pydoctor.node2stan.HTMLTranslator
  pydoctor.node2stan.HTMLTranslator.html
  Class
  Class
  PUBLIC
  Pydoctor's HTML translator.
• pydoctor.node2stan.HTMLTranslator.settings
  pydoctor.node2stan.HTMLTranslator.html#settings
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.body
  pydoctor.node2stan.HTMLTranslator.html#body
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.__init__
  pydoctor.node2stan.HTMLTranslator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator._linker
  pydoctor.node2stan.HTMLTranslator.html#_linker
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.node2stan.HTMLTranslator._document_is_code
  pydoctor.node2stan.HTMLTranslator.html#_document_is_code
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.node2stan.HTMLTranslator._link_xref
  pydoctor.node2stan.HTMLTranslator.html#_link_xref
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_title_reference
  pydoctor.node2stan.HTMLTranslator.html#visit_title_reference
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_obj_reference
  pydoctor.node2stan.HTMLTranslator.html#visit_obj_reference
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator._handle_reference
  pydoctor.node2stan.HTMLTranslator.html#_handle_reference
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_code
  pydoctor.node2stan.HTMLTranslator.html#visit_code
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_code
  pydoctor.node2stan.HTMLTranslator.html#depart_code
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.should_be_compact_paragraph
  pydoctor.node2stan.HTMLTranslator.html#should_be_compact_paragraph
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_document
  pydoctor.node2stan.HTMLTranslator.html#visit_document
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_document
  pydoctor.node2stan.HTMLTranslator.html#depart_document
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.starttag
  pydoctor.node2stan.HTMLTranslator.html#starttag
  Function
  Method
  PUBLIC
  This modified version of starttag makes a few changes to HTML tags, to prevent them from conflicting with epydoc. In particular:
• pydoctor.node2stan.HTMLTranslator.visit_doctest_block
  pydoctor.node2stan.HTMLTranslator.html#visit_doctest_block
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator._visit_admonition
  pydoctor.node2stan.HTMLTranslator.html#_visit_admonition
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_admonition
  pydoctor.node2stan.HTMLTranslator.html#depart_admonition
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_note
  pydoctor.node2stan.HTMLTranslator.html#visit_note
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_note
  pydoctor.node2stan.HTMLTranslator.html#depart_note
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_warning
  pydoctor.node2stan.HTMLTranslator.html#visit_warning
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_warning
  pydoctor.node2stan.HTMLTranslator.html#depart_warning
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_attention
  pydoctor.node2stan.HTMLTranslator.html#visit_attention
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_attention
  pydoctor.node2stan.HTMLTranslator.html#depart_attention
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_caution
  pydoctor.node2stan.HTMLTranslator.html#visit_caution
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_caution
  pydoctor.node2stan.HTMLTranslator.html#depart_caution
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_danger
  pydoctor.node2stan.HTMLTranslator.html#visit_danger
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_danger
  pydoctor.node2stan.HTMLTranslator.html#depart_danger
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_error
  pydoctor.node2stan.HTMLTranslator.html#visit_error
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_error
  pydoctor.node2stan.HTMLTranslator.html#depart_error
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_hint
  pydoctor.node2stan.HTMLTranslator.html#visit_hint
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_hint
  pydoctor.node2stan.HTMLTranslator.html#depart_hint
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_important
  pydoctor.node2stan.HTMLTranslator.html#visit_important
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_important
  pydoctor.node2stan.HTMLTranslator.html#depart_important
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_tip
  pydoctor.node2stan.HTMLTranslator.html#visit_tip
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_tip
  pydoctor.node2stan.HTMLTranslator.html#depart_tip
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_wbr
  pydoctor.node2stan.HTMLTranslator.html#visit_wbr
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_wbr
  pydoctor.node2stan.HTMLTranslator.html#depart_wbr
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_seealso
  pydoctor.node2stan.HTMLTranslator.html#visit_seealso
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_seealso
  pydoctor.node2stan.HTMLTranslator.html#depart_seealso
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.visit_versionmodified
  pydoctor.node2stan.HTMLTranslator.html#visit_versionmodified
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.node2stan.HTMLTranslator.depart_versionmodified
  pydoctor.node2stan.HTMLTranslator.html#depart_versionmodified
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.factory.GenericFactory
  pydoctor.factory.GenericFactory.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 2/4 methods documented
• pydoctor.factory.GenericFactory.__init__
  pydoctor.factory.GenericFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.factory.GenericFactory.bases
  pydoctor.factory.GenericFactory.html#bases
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.factory.GenericFactory.mixins
  pydoctor.factory.GenericFactory.html#mixins
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.factory.GenericFactory._class_cache
  pydoctor.factory.GenericFactory.html#_class_cache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.factory.GenericFactory.add_mixin
  pydoctor.factory.GenericFactory.html#add_mixin
  Function
  Method
  PUBLIC
  Add a mixin class to the specified object in the factory.
• pydoctor.factory.GenericFactory.add_mixins
  pydoctor.factory.GenericFactory.html#add_mixins
  Function
  Method
  PUBLIC
  Add mixin classes to objects in the factory. Example:
• pydoctor.factory.GenericFactory.get_class
  pydoctor.factory.GenericFactory.html#get_class
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.factory.Factory
  pydoctor.factory.Factory.html
  Class
  Class
  PUBLIC
  Classes are created dynamically with `type` such that they can inherith from customizable mixin classes.
• pydoctor.factory.Factory.__init__
  pydoctor.factory.Factory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.factory.Factory.model
  pydoctor.factory.Factory.html#model
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.factory.Factory.add_mixin
  pydoctor.factory.Factory.html#add_mixin
  Function
  Method
  PUBLIC
  Add a mixin class to the specified object in the factory.
• pydoctor.factory.Factory.Class
  pydoctor.factory.Factory.html#Class
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.factory.Factory.Function
  pydoctor.factory.Factory.html#Function
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.factory.Factory.Module
  pydoctor.factory.Factory.html#Module
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.factory.Factory.Package
  pydoctor.factory.Factory.html#Package
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.factory.Factory.Attribute
  pydoctor.factory.Factory.html#Attribute
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.qnmatch._compile_pattern
  pydoctor.qnmatch.html#_compile_pattern
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.qnmatch.qnmatch
  pydoctor.qnmatch.html#qnmatch
  Function
  Function
  PUBLIC
  Test whether name matches pattern.
• pydoctor.qnmatch.translate
  pydoctor.qnmatch.html#translate
  Function
  Function
  PUBLIC
  Translate a shell PATTERN to a regular expression. There is no way to quote meta-characters.
• pydoctor.utils.T
  pydoctor.utils.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.utils.error
  pydoctor.utils.html#error
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.utils.findClassFromDottedName
  pydoctor.utils.html#findClassFromDottedName
  Function
  Function
  PUBLIC
  Looks up a class by full name.
• pydoctor.utils.resolve_path
  pydoctor.utils.html#resolve_path
  Function
  Function
  PUBLIC
  Parse a given path string to a Path object.
• pydoctor.utils.parse_path
  pydoctor.utils.html#parse_path
  Function
  Function
  PUBLIC
  Parse a str path to a Path object using resolve_path().
• pydoctor.utils.parse_privacy_tuple
  pydoctor.utils.html#parse_privacy_tuple
  Function
  Function
  PUBLIC
  Parse string like 'public:match*' to a tuple (PrivacyClass.PUBLIC, 'match*').
• pydoctor.utils.partialclass
  pydoctor.utils.html#partialclass
  Function
  Function
  PUBLIC
  Bind a class to be created with some predefined __init__ arguments.
• pydoctor.linker.taglink
  pydoctor.linker.html#taglink
  Function
  Function
  PUBLIC
  Create a link to an object that exists in the system.
• pydoctor.linker.intersphinx_link
  pydoctor.linker.html#intersphinx_link
  Function
  Function
  PUBLIC
  Create a intersphinx link.
• pydoctor.linker._EpydocLinker
  pydoctor.linker._EpydocLinker.html
  Class
  Class
  PRIVATE
  This linker implements the xref lookup logic.
• pydoctor.linker._EpydocLinker.__init__
  pydoctor.linker._EpydocLinker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.linker._EpydocLinker.reporting_obj
  pydoctor.linker._EpydocLinker.html#reporting_obj
  Attribute
  Instance Variable
  PUBLIC
  Object used for reporting link not found errors. Changed when the linker switch_context.
• pydoctor.linker._EpydocLinker._init_obj
  pydoctor.linker._EpydocLinker.html#_init_obj
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.linker._EpydocLinker._page_object
  pydoctor.linker._EpydocLinker.html#_page_object
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.linker._EpydocLinker.obj
  pydoctor.linker._EpydocLinker.html#obj
  Attribute
  Property
  PUBLIC
  Object used for resolving the target name, it's NOT changed when the linker switch_context.
• pydoctor.linker._EpydocLinker.page_url
  pydoctor.linker._EpydocLinker.html#page_url
  Attribute
  Property
  PUBLIC
  URL of the page used to compute the relative links from. Can be an empty string to always generate full urls.
• pydoctor.linker._EpydocLinker.switch_context
  pydoctor.linker._EpydocLinker.html#switch_context
  Function
  Method
  PUBLIC
  Switch the context of the linker, keeping the same underlying lookup rules.
• pydoctor.linker._EpydocLinker.look_for_name
  pydoctor.linker._EpydocLinker.html#look_for_name
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.linker._EpydocLinker.look_for_intersphinx
  pydoctor.linker._EpydocLinker.html#look_for_intersphinx
  Function
  Method
  PUBLIC
  Return link for `name` based on intersphinx inventory.
• pydoctor.linker._EpydocLinker.link_to
  pydoctor.linker._EpydocLinker.html#link_to
  Function
  Method
  PUBLIC
  Format a link to a Python identifier. This will resolve the identifier like Python itself would.
• pydoctor.linker._EpydocLinker.link_xref
  pydoctor.linker._EpydocLinker.html#link_xref
  Function
  Method
  PUBLIC
  Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
• pydoctor.linker._EpydocLinker._resolve_identifier_xref
  pydoctor.linker._EpydocLinker.html#_resolve_identifier_xref
  Function
  Method
  PRIVATE
  Resolve a crossreference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
• pydoctor.linker.NotFoundLinker
  pydoctor.linker.NotFoundLinker.html
  Class
  Class
  PUBLIC
  A DocstringLinker implementation that cannot find any links.
• pydoctor.linker.NotFoundLinker.link_to
  pydoctor.linker.NotFoundLinker.html#link_to
  Function
  Method
  PUBLIC
  Format a link to a Python identifier. This will resolve the identifier like Python itself would.
• pydoctor.linker.NotFoundLinker.link_xref
  pydoctor.linker.NotFoundLinker.html#link_xref
  Function
  Method
  PUBLIC
  Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
• pydoctor.linker.NotFoundLinker.switch_context
  pydoctor.linker.NotFoundLinker.html#switch_context
  Function
  Method
  PUBLIC
  Switch the context of the linker, keeping the same underlying lookup rules.
• pydoctor.visitor.T
  pydoctor.visitor.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.visitor._BaseVisitor
  pydoctor.visitor._BaseVisitor.html
  Class
  Class
  PRIVATE
  No class docstring; 4/4 methods documented
• pydoctor.visitor._BaseVisitor.visit
  pydoctor.visitor._BaseVisitor.html#visit
  Function
  Method
  PUBLIC
  Visit an object.
• pydoctor.visitor._BaseVisitor.depart
  pydoctor.visitor._BaseVisitor.html#depart
  Function
  Method
  PUBLIC
  Depart an object.
• pydoctor.visitor._BaseVisitor.unknown_visit
  pydoctor.visitor._BaseVisitor.html#unknown_visit
  Function
  Method
  PUBLIC
  Called when entering unknown object types.
• pydoctor.visitor._BaseVisitor.unknown_departure
  pydoctor.visitor._BaseVisitor.html#unknown_departure
  Function
  Method
  PUBLIC
  Called before exiting unknown object types.
• pydoctor.visitor.Visitor
  pydoctor.visitor.Visitor.html
  Class
  Class
  PUBLIC
  "Visitor" pattern abstract superclass implementation for tree traversals.
• pydoctor.visitor.Visitor.__init__
  pydoctor.visitor.Visitor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.visitor.Visitor.extensions
  pydoctor.visitor.Visitor.html#extensions
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.visitor.Visitor._skipped_nodes
  pydoctor.visitor.Visitor.html#_skipped_nodes
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.visitor.Visitor.get_children
  pydoctor.visitor.Visitor.html#get_children
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.visitor.Visitor._TreePruningException
  pydoctor.visitor.Visitor._TreePruningException.html
  Class
  Exception
  PRIVATE
  Base class for Visitor-related tree pruning exceptions.
• pydoctor.visitor.Visitor.SkipChildren
  pydoctor.visitor.Visitor.SkipChildren.html
  Class
  Exception
  PUBLIC
  Do not visit any children of the current node. The current node's siblings and depart_... method are not affected.
• pydoctor.visitor.Visitor.SkipNode
  pydoctor.visitor.Visitor.SkipNode.html
  Class
  Exception
  PUBLIC
  Do not visit the current node's children, and do not call the current node's depart_... method. The extensions will still be called.
• pydoctor.visitor.Visitor.IgnoreNode
  pydoctor.visitor.Visitor.IgnoreNode.html
  Class
  Exception
  PUBLIC
  Comletely stop visiting the current node, extensions will not be run on that node.
• pydoctor.visitor.Visitor.visit
  pydoctor.visitor.Visitor.html#visit
  Function
  Method
  PUBLIC
  Extend the base visit with extensions.
• pydoctor.visitor.Visitor.depart
  pydoctor.visitor.Visitor.html#depart
  Function
  Method
  PUBLIC
  Extend the base depart with extensions.
• pydoctor.visitor.Visitor.walkabout
  pydoctor.visitor.Visitor.html#walkabout
  Function
  Method
  PUBLIC
  Perform a tree traversal, calling visit() method when entering a node and the depart() method before exiting each node.
• pydoctor.visitor.PartialVisitor
  pydoctor.visitor.PartialVisitor.html
  Class
  Class
  PUBLIC
  Visitor class that do not have to define all possible visit_.* methods since it overrides the default behaviour of unknown_visit() and unknown_departure() not to raise NotImplementedError.
• pydoctor.visitor.PartialVisitor.unknown_visit
  pydoctor.visitor.PartialVisitor.html#unknown_visit
  Function
  Method
  PUBLIC
  Called when entering unknown object types.
• pydoctor.visitor.PartialVisitor.unknown_departure
  pydoctor.visitor.PartialVisitor.html#unknown_departure
  Function
  Method
  PUBLIC
  Called before exiting unknown object types.
• pydoctor.visitor.When
  pydoctor.visitor.When.html
  Class
  Class
  PUBLIC
  This enumeration contains the different times an extension methods are called.
• pydoctor.visitor.When.BEFORE
  pydoctor.visitor.When.html#BEFORE
  Attribute
  Constant
  PUBLIC
  For each node, call extension methods before the method of the customizable visitor.
• pydoctor.visitor.When.AFTER
  pydoctor.visitor.When.html#AFTER
  Attribute
  Constant
  PUBLIC
  For each node, call extension methods after the method of the customizable visitor.
• pydoctor.visitor.When.INNER
  pydoctor.visitor.When.html#INNER
  Attribute
  Constant
  PUBLIC
  Same as AFTER except that the depart() method will be called before calling depart() on the customizable visitor.
• pydoctor.visitor.When.OUTTER
  pydoctor.visitor.When.html#OUTTER
  Attribute
  Constant
  PUBLIC
  Same as BEFORE except that the depart() method will be called after calling depart() on the customizable visitor.
• pydoctor.visitor.ExtList
  pydoctor.visitor.ExtList.html
  Class
  Class
  PUBLIC
  This class helps iterating on visitor extensions that should run at different times.
• pydoctor.visitor.ExtList.__init__
  pydoctor.visitor.ExtList.html#__init__
  Function
  Method
  PUBLIC
  Initialize the extensions container.
• pydoctor.visitor.ExtList._visitors
  pydoctor.visitor.ExtList.html#_visitors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.visitor.ExtList.add
  pydoctor.visitor.ExtList.html#add
  Function
  Method
  PUBLIC
  Add extensions to this container.
• pydoctor.visitor.ExtList.attach_visitor
  pydoctor.visitor.ExtList.html#attach_visitor
  Function
  Method
  PUBLIC
  Attach a parent visitor to the visitor extensions.
• pydoctor.visitor.ExtList.before_visit
  pydoctor.visitor.ExtList.html#before_visit
  Attribute
  Property
  PUBLIC
  Return the visitors that run before the visit.
• pydoctor.visitor.ExtList.after_visit
  pydoctor.visitor.ExtList.html#after_visit
  Attribute
  Property
  PUBLIC
  Return the visitors that run after the visit.
• pydoctor.visitor.ExtList.inner_visit
  pydoctor.visitor.ExtList.html#inner_visit
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.visitor.ExtList.outter_visit
  pydoctor.visitor.ExtList.html#outter_visit
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.visitor.VisitorExt
  pydoctor.visitor.VisitorExt.html
  Class
  Class
  PUBLIC
  The node visitor extension base class, to inherit from.
• pydoctor.visitor.VisitorExt.__init__
  pydoctor.visitor.VisitorExt.html#__init__
  Function
  Method
  PUBLIC
  Initialize the visitor extension.
• pydoctor.visitor.VisitorExt.visitor
  pydoctor.visitor.VisitorExt.html#visitor
  Attribute
  Instance Variable
  PUBLIC
  The parent visitor
• pydoctor.visitor.VisitorExt.unknown_visit
  pydoctor.visitor.VisitorExt.html#unknown_visit
  Function
  Method
  PUBLIC
  Called when entering unknown object types.
• pydoctor.visitor.VisitorExt.unknown_departure
  pydoctor.visitor.VisitorExt.html#unknown_departure
  Function
  Method
  PUBLIC
  Called before exiting unknown object types.
• pydoctor.visitor.VisitorExt.attach
  pydoctor.visitor.VisitorExt.html#attach
  Function
  Method
  PUBLIC
  Attach the parent visitor to this extension.
• pydoctor.astutils.iter_values
  pydoctor.astutils.html#iter_values
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils.NodeVisitor
  pydoctor.astutils.NodeVisitor.html
  Class
  Class
  PUBLIC
  Generic AST node visitor. This class does not work like ast.NodeVisitor, it only visits statements directly within a body. Also, visitor methods can't return anything.
• pydoctor.astutils.NodeVisitor.generic_visit
  pydoctor.astutils.NodeVisitor.html#generic_visit
  Function
  Method
  PUBLIC
  Helper method to visit a node by calling visit() on each child of the node. This is useful because this vistitor only visits statements inside .body attribute.
• pydoctor.astutils.NodeVisitor.get_children
  pydoctor.astutils.NodeVisitor.html#get_children
  Function
  Class Method
  PUBLIC
  Returns the nested nodes in the body of a node.
• pydoctor.astutils.NodeVisitorExt
  pydoctor.astutils.NodeVisitorExt.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.astutils._AssingT
  pydoctor.astutils.html#_AssingT
  Attribute
  Type Alias
  PRIVATE
  Undocumented
• pydoctor.astutils.iterassign
  pydoctor.astutils.html#iterassign
  Function
  Function
  PUBLIC
  Utility function to iterate assignments targets.
• pydoctor.astutils.node2dottedname
  pydoctor.astutils.html#node2dottedname
  Function
  Function
  PUBLIC
  Resove expression composed by ast.Attribute and ast.Name nodes to a list of names.
• pydoctor.astutils.node2fullname
  pydoctor.astutils.html#node2fullname
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils.bind_args
  pydoctor.astutils.html#bind_args
  Function
  Function
  PUBLIC
  Binds the arguments of a function call to that function's signature.
• pydoctor.astutils.get_str_value
  pydoctor.astutils.html#get_str_value
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils.get_num_value
  pydoctor.astutils.html#get_num_value
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils._is_str_constant
  pydoctor.astutils.html#_is_str_constant
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.astutils.get_int_value
  pydoctor.astutils.html#get_int_value
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils.is__name__equals__main__
  pydoctor.astutils.html#is__name__equals__main__
  Function
  Function
  PUBLIC
  Returns whether or not the given ast.Compare is equal to __name__ == '__main__'.
• pydoctor.astutils.is_using_typing_final
  pydoctor.astutils.html#is_using_typing_final
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils.is_using_typing_classvar
  pydoctor.astutils.html#is_using_typing_classvar
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.astutils.is_using_annotations
  pydoctor.astutils.html#is_using_annotations
  Function
  Function
  PUBLIC
  Detect if this expr is firstly composed by one of the specified annotation(s)' full name.
• pydoctor.astutils.get_node_block
  pydoctor.astutils.html#get_node_block
  Function
  Function
  PUBLIC
  Tell in wich block the given node lives in.
• pydoctor.astutils.get_assign_docstring_node
  pydoctor.astutils.html#get_assign_docstring_node
  Function
  Function
  PUBLIC
  Get the docstring for a ast.Assign or ast.AnnAssign node.
• pydoctor.astutils.is_none_literal
  pydoctor.astutils.html#is_none_literal
  Function
  Function
  PUBLIC
  Does this AST node represent the literal constant None?
• pydoctor.astutils.unstring_annotation
  pydoctor.astutils.html#unstring_annotation
  Function
  Function
  PUBLIC
  Replace all strings in the given expression by parsed versions.
• pydoctor.astutils._AnnotationStringParser
  pydoctor.astutils._AnnotationStringParser.html
  Class
  Class
  PRIVATE
  Implementation of unstring_annotation().
• pydoctor.astutils._AnnotationStringParser._parse_string
  pydoctor.astutils._AnnotationStringParser.html#_parse_string
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astutils._AnnotationStringParser.visit_Subscript
  pydoctor.astutils._AnnotationStringParser.html#visit_Subscript
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._AnnotationStringParser.visit_fast
  pydoctor.astutils._AnnotationStringParser.html#visit_fast
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._AnnotationStringParser.visit_Constant
  pydoctor.astutils._AnnotationStringParser.html#visit_Constant
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.upgrade_annotation
  pydoctor.astutils.html#upgrade_annotation
  Function
  Function
  PUBLIC
  Transform the annotation to use python 3.10+ syntax.
• pydoctor.astutils._UpgradeDeprecatedAnnotations
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html
  Class
  Class
  PRIVATE
  Undocumented
• pydoctor.astutils._UpgradeDeprecatedAnnotations.visit
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html#visit
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._UpgradeDeprecatedAnnotations.__init__
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._UpgradeDeprecatedAnnotations.node2fullname
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html#node2fullname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astutils._UpgradeDeprecatedAnnotations._union_args_to_bitor
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html#_union_args_to_bitor
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astutils._UpgradeDeprecatedAnnotations.visit_Name
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html#visit_Name
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._UpgradeDeprecatedAnnotations.visit_Subscript
  pydoctor.astutils._UpgradeDeprecatedAnnotations.html#visit_Subscript
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.DEPRECATED_TYPING_ALIAS_BUILTINS
  pydoctor.astutils.html#DEPRECATED_TYPING_ALIAS_BUILTINS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.astutils.TYPING_ALIAS
  pydoctor.astutils.html#TYPING_ALIAS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.astutils.SUBSCRIPTABLE_CLASSES_PEP585
  pydoctor.astutils.html#SUBSCRIPTABLE_CLASSES_PEP585
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.astutils.is_typing_annotation
  pydoctor.astutils.html#is_typing_annotation
  Function
  Function
  PUBLIC
  Whether this annotation node refers to a typing alias.
• pydoctor.astutils.get_docstring_node
  pydoctor.astutils.html#get_docstring_node
  Function
  Function
  PUBLIC
  Return the docstring node for the given class, function or module or None if no docstring can be found.
• pydoctor.astutils._StrMeta
  pydoctor.astutils._StrMeta.html
  Class
  Class
  PRIVATE
  Undocumented
• pydoctor.astutils._StrMeta.__instancecheck__
  pydoctor.astutils._StrMeta.html#__instancecheck__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.Str
  pydoctor.astutils.Str.html
  Class
  Class
  PUBLIC
  Wraps ast.Constant/ast.Str for `isinstance` checks and annotations. Ensures that the value is actually a string. Do not try to instanciate this class.
• pydoctor.astutils.Str.value
  pydoctor.astutils.Str.html#value
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.astutils.Str.__init__
  pydoctor.astutils.Str.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.extract_docstring_linenum
  pydoctor.astutils.html#extract_docstring_linenum
  Function
  Function
  PUBLIC
  In older CPython versions, the AST only tells us the end line number and we must approximate the start line number. This approximation is correct if the docstring does not contain explicit newlines ('\n') or joined lines ('\' at end of line).
• pydoctor.astutils.extract_docstring
  pydoctor.astutils.html#extract_docstring
  Function
  Function
  PUBLIC
  Extract docstring information from an ast node that represents the docstring.
• pydoctor.astutils.infer_type
  pydoctor.astutils.html#infer_type
  Function
  Function
  PUBLIC
  Infer a literal expression's type.
• pydoctor.astutils._annotation_for_value
  pydoctor.astutils.html#_annotation_for_value
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.astutils._annotation_for_elements
  pydoctor.astutils.html#_annotation_for_elements
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.astutils.Parentage
  pydoctor.astutils.Parentage.html
  Class
  Class
  PUBLIC
  Add parent attribute to ast nodes instances.
• pydoctor.astutils.Parentage.__init__
  pydoctor.astutils.Parentage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.Parentage.current
  pydoctor.astutils.Parentage.html#current
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astutils.Parentage.generic_visit
  pydoctor.astutils.Parentage.html#generic_visit
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.get_parents
  pydoctor.astutils.html#get_parents
  Function
  Function
  PUBLIC
  Once nodes have the .parent attribute with {Parentage}, use this function to get a iterator on all parents of the given node up to the root module.
• pydoctor.astutils._op_data
  pydoctor.astutils.html#_op_data
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.astutils._deprecated
  pydoctor.astutils.html#_deprecated
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.astutils._precedence_data
  pydoctor.astutils.html#_precedence_data
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.astutils._symbol_data
  pydoctor.astutils.html#_symbol_data
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.astutils.op_util
  pydoctor.astutils.op_util.html
  Class
  Class
  PUBLIC
  This class provides data and functions for mapping AST nodes to symbols and precedences.
• pydoctor.astutils.op_util.get_op_symbol
  pydoctor.astutils.op_util.html#get_op_symbol
  Function
  Class Method
  PUBLIC
  Given an AST node object, returns a string containing the symbol.
• pydoctor.astutils.op_util.get_op_precedence
  pydoctor.astutils.op_util.html#get_op_precedence
  Function
  Class Method
  PUBLIC
  Given an AST node object, returns the precedence.
• pydoctor.astutils.op_util.Precedence
  pydoctor.astutils.op_util.Precedence.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.astutils.op_util.Precedence.highest
  pydoctor.astutils.op_util.Precedence.html#highest
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.astutils.has_comment_line
  pydoctor.astutils.html#has_comment_line
  Function
  Function
  PUBLIC
  Returns True if the is a comment line in between node1 and node2.
• pydoctor.astutils._OldSchoolNamespacePackageVis
  pydoctor.astutils._OldSchoolNamespacePackageVis.html
  Class
  Class
  PRIVATE
  Undocumented
• pydoctor.astutils._OldSchoolNamespacePackageVis.is_namespace_package
  pydoctor.astutils._OldSchoolNamespacePackageVis.html#is_namespace_package
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astutils._OldSchoolNamespacePackageVis.visit_Module
  pydoctor.astutils._OldSchoolNamespacePackageVis.html#visit_Module
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._OldSchoolNamespacePackageVis.visit_skip
  pydoctor.astutils._OldSchoolNamespacePackageVis.html#visit_skip
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._OldSchoolNamespacePackageVis.visit_Expr
  pydoctor.astutils._OldSchoolNamespacePackageVis.html#visit_Expr
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._OldSchoolNamespacePackageVis.visit_Assign
  pydoctor.astutils._OldSchoolNamespacePackageVis.html#visit_Assign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils._OldSchoolNamespacePackageVis.visit_AnnAssign
  pydoctor.astutils._OldSchoolNamespacePackageVis.html#visit_AnnAssign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astutils.is_old_school_namespace_package
  pydoctor.astutils.html#is_old_school_namespace_package
  Function
  Function
  PUBLIC
  Returns True if the module is a pre PEP 420 namespace package:
• pydoctor.mro.LinearizationError
  pydoctor.mro.LinearizationError.html
  Class
  Exception
  PUBLIC
  Undocumented
• pydoctor.mro.T
  pydoctor.mro.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.mro.Dependency
  pydoctor.mro.Dependency.html
  Class
  Class
  PUBLIC
  No class docstring; 1/2 property documented
• pydoctor.mro.Dependency.head
  pydoctor.mro.Dependency.html#head
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.mro.Dependency.tail
  pydoctor.mro.Dependency.html#tail
  Attribute
  Property
  PUBLIC
  Return islice object, which is suffice for iteration or calling `in`
• pydoctor.mro.DependencyList
  pydoctor.mro.DependencyList.html
  Class
  Class
  PUBLIC
  A class represents list of linearizations (dependencies) The last element of DependencyList is a list of parents. It's needed to the merge process preserves the local precedence order of direct parent classes.
• pydoctor.mro.DependencyList.__init__
  pydoctor.mro.DependencyList.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.mro.DependencyList._lists
  pydoctor.mro.DependencyList.html#_lists
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.mro.DependencyList.__contains__
  pydoctor.mro.DependencyList.html#__contains__
  Function
  Method
  PUBLIC
  Return True if any linearization's tail contains an item
• pydoctor.mro.DependencyList.__len__
  pydoctor.mro.DependencyList.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.mro.DependencyList.__repr__
  pydoctor.mro.DependencyList.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.mro.DependencyList.heads
  pydoctor.mro.DependencyList.html#heads
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.mro.DependencyList.tails
  pydoctor.mro.DependencyList.html#tails
  Attribute
  Property
  PUBLIC
  Return self so that __contains__ could be called Used for readability reasons only
• pydoctor.mro.DependencyList.exhausted
  pydoctor.mro.DependencyList.html#exhausted
  Attribute
  Property
  PUBLIC
  Return True if all elements of the lists are exhausted
• pydoctor.mro.DependencyList.remove
  pydoctor.mro.DependencyList.html#remove
  Function
  Method
  PUBLIC
  Remove an item from the lists Once an item removed from heads, the leftmost elements of the tails get promoted to become the new heads.
• pydoctor.mro.c3_merge
  pydoctor.mro.html#c3_merge
  Function
  Function
  PUBLIC
  The merge operation of the C3 superclass linearization algorithm.
• pydoctor.sphinx.CacheT
  pydoctor.sphinx.CacheT.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.sphinx.CacheT.get
  pydoctor.sphinx.CacheT.html#get
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.CacheT.close
  pydoctor.sphinx.CacheT.html#close
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.logger
  pydoctor.sphinx.html#logger
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.sphinx.SphinxInventory
  pydoctor.sphinx.SphinxInventory.html
  Class
  Class
  PUBLIC
  Sphinx inventory handler.
• pydoctor.sphinx.SphinxInventory.__init__
  pydoctor.sphinx.SphinxInventory.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.sphinx.SphinxInventory._links
  pydoctor.sphinx.SphinxInventory.html#_links
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx.SphinxInventory._logger
  pydoctor.sphinx.SphinxInventory.html#_logger
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx.SphinxInventory.error
  pydoctor.sphinx.SphinxInventory.html#error
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.SphinxInventory.update
  pydoctor.sphinx.SphinxInventory.html#update
  Function
  Method
  PUBLIC
  Update inventory from URL.
• pydoctor.sphinx.SphinxInventory.update_file
  pydoctor.sphinx.SphinxInventory.html#update_file
  Function
  Method
  PUBLIC
  Update inventory from local path. If base_url is supplied, the links are made relative to the supplied base url.
• pydoctor.sphinx.SphinxInventory._getPayload
  pydoctor.sphinx.SphinxInventory.html#_getPayload
  Function
  Method
  PRIVATE
  Parse inventory and return clear text payload without comments.
• pydoctor.sphinx.SphinxInventory._parseInventory
  pydoctor.sphinx.SphinxInventory.html#_parseInventory
  Function
  Method
  PRIVATE
  Parse clear text payload and return a dict with module to link mapping.
• pydoctor.sphinx.SphinxInventory.getLink
  pydoctor.sphinx.SphinxInventory.html#getLink
  Function
  Method
  PUBLIC
  Return link for `name` or None if no link is found.
• pydoctor.sphinx._parseInventoryLine
  pydoctor.sphinx.html#_parseInventoryLine
  Function
  Function
  PRIVATE
  Parse a single line from a Sphinx inventory.
• pydoctor.sphinx.SphinxInventoryWriter
  pydoctor.sphinx.SphinxInventoryWriter.html
  Class
  Class
  PUBLIC
  Sphinx inventory handler.
• pydoctor.sphinx.SphinxInventoryWriter.__init__
  pydoctor.sphinx.SphinxInventoryWriter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.SphinxInventoryWriter._project_name
  pydoctor.sphinx.SphinxInventoryWriter.html#_project_name
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx.SphinxInventoryWriter._project_version
  pydoctor.sphinx.SphinxInventoryWriter.html#_project_version
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx.SphinxInventoryWriter._logger
  pydoctor.sphinx.SphinxInventoryWriter.html#_logger
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx.SphinxInventoryWriter.info
  pydoctor.sphinx.SphinxInventoryWriter.html#info
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.SphinxInventoryWriter.error
  pydoctor.sphinx.SphinxInventoryWriter.html#error
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.SphinxInventoryWriter.generate
  pydoctor.sphinx.SphinxInventoryWriter.html#generate
  Function
  Method
  PUBLIC
  Generate Sphinx objects inventory version 2 at `basepath`/objects.inv.
• pydoctor.sphinx.SphinxInventoryWriter._openFileForWriting
  pydoctor.sphinx.SphinxInventoryWriter.html#_openFileForWriting
  Function
  Method
  PRIVATE
  Helper for testing.
• pydoctor.sphinx.SphinxInventoryWriter._generateHeader
  pydoctor.sphinx.SphinxInventoryWriter.html#_generateHeader
  Function
  Method
  PRIVATE
  Return header for project with name.
• pydoctor.sphinx.SphinxInventoryWriter._generateContent
  pydoctor.sphinx.SphinxInventoryWriter.html#_generateContent
  Function
  Method
  PRIVATE
  Write inventory for all `subjects`.
• pydoctor.sphinx.SphinxInventoryWriter._generateLine
  pydoctor.sphinx.SphinxInventoryWriter.html#_generateLine
  Function
  Method
  PRIVATE
  Return inventory line for object.
• pydoctor.sphinx.USER_INTERSPHINX_CACHE
  pydoctor.sphinx.html#USER_INTERSPHINX_CACHE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.sphinx._Unit
  pydoctor.sphinx._Unit.html
  Class
  Class
  PRIVATE
  A unit of time for maximum age parsing.
• pydoctor.sphinx._Unit.name
  pydoctor.sphinx._Unit.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name of the unit.
• pydoctor.sphinx._Unit.minimum
  pydoctor.sphinx._Unit.html#minimum
  Attribute
  Instance Variable
  PUBLIC
  The minimum value, inclusive.
• pydoctor.sphinx._Unit.maximum
  pydoctor.sphinx._Unit.html#maximum
  Attribute
  Instance Variable
  PUBLIC
  The maximum value, exclusive.
• pydoctor.sphinx._maxAgeUnits
  pydoctor.sphinx.html#_maxAgeUnits
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx._maxAgeUnitNames
  pydoctor.sphinx.html#_maxAgeUnitNames
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.sphinx.MAX_AGE_HELP
  pydoctor.sphinx.html#MAX_AGE_HELP
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.sphinx.MAX_AGE_DEFAULT
  pydoctor.sphinx.html#MAX_AGE_DEFAULT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.sphinx.InvalidMaxAge
  pydoctor.sphinx.InvalidMaxAge.html
  Class
  Exception
  PUBLIC
  Raised when a string cannot be parsed as a maximum age.
• pydoctor.sphinx.parseMaxAge
  pydoctor.sphinx.html#parseMaxAge
  Function
  Function
  PUBLIC
  Parse a string into a maximum age dictionary.
• pydoctor.sphinx.IntersphinxCache
  pydoctor.sphinx.IntersphinxCache.html
  Class
  Class
  PUBLIC
  An Intersphinx cache.
• pydoctor.sphinx.IntersphinxCache._session
  pydoctor.sphinx.IntersphinxCache.html#_session
  Attribute
  Instance Variable
  PRIVATE
  A session that may or may not cache requests.
• pydoctor.sphinx.IntersphinxCache.fromParameters
  pydoctor.sphinx.IntersphinxCache.html#fromParameters
  Function
  Class Method
  PUBLIC
  Construct an instance with the given parameters.
• pydoctor.sphinx.IntersphinxCache.get
  pydoctor.sphinx.IntersphinxCache.html#get
  Function
  Method
  PUBLIC
  Retrieve a URL using the cache.
• pydoctor.sphinx.IntersphinxCache.close
  pydoctor.sphinx.IntersphinxCache.html#close
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.sphinx.prepareCache
  pydoctor.sphinx.html#prepareCache
  Function
  Function
  PUBLIC
  Prepare an Intersphinx cache.
• pydoctor.epydoc.markup.restructuredtext.CONSOLIDATED_FIELDS
  pydoctor.epydoc.markup.restructuredtext.html#CONSOLIDATED_FIELDS
  Attribute
  Constant
  PUBLIC
  A dictionary encoding the set of 'consolidated fields' that can be used. Each consolidated field is marked by a single tag, and contains a single bulleted list, where each list item starts with an identifier, marked as interpreted text (...
• pydoctor.epydoc.markup.plaintext.parse_docstring
  pydoctor.epydoc.markup.plaintext.html#parse_docstring
  Function
  Function
  PUBLIC
  Parse the given docstring, which is formatted as plain text; and return a ParsedDocstring representation of its contents.
• pydoctor.epydoc.markup.plaintext.get_parser
  pydoctor.epydoc.markup.plaintext.html#get_parser
  Function
  Function
  PUBLIC
  Just return the parse_docstring function.
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring._text
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html#_text
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring._document
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html#_document
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.has_body
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html#has_body
  Attribute
  Property
  PUBLIC
  Does this docstring have a non-empty body?
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.to_stan
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html#to_stan
  Function
  Method
  PUBLIC
  Translate this docstring to a Stan tree.
• pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.to_node
  pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring.html#to_node
  Function
  Method
  PUBLIC
  Translate this docstring to a nodes.document.
• pydoctor.epydoc.markup.restructuredtext.CONSOLIDATED_DEFLIST_FIELDS
  pydoctor.epydoc.markup.restructuredtext.html#CONSOLIDATED_DEFLIST_FIELDS
  Attribute
  Constant
  PUBLIC
  A list of consolidated fields whose bodies may be specified using a definition list, rather than a bulleted list. For these fields, the 'classifier' for each term in the definition list is translated into a @type field.
• pydoctor.epydoc.markup.restructuredtext.parse_docstring
  pydoctor.epydoc.markup.restructuredtext.html#parse_docstring
  Function
  Function
  PUBLIC
  Parse the given docstring, which is formatted using ReStructuredText; and return a ParsedDocstring representation of its contents.
• pydoctor.epydoc.markup.restructuredtext.get_parser
  pydoctor.epydoc.markup.restructuredtext.html#get_parser
  Function
  Function
  PUBLIC
  Get the parse_docstring function.
• pydoctor.epydoc.markup.restructuredtext.OptimizedReporter
  pydoctor.epydoc.markup.restructuredtext.OptimizedReporter.html
  Class
  Class
  PUBLIC
  A reporter that ignores all debug messages. This is used to shave a couple seconds off of epydoc's run time, since docutils isn't very fast about processing its own debug messages.
• pydoctor.epydoc.markup.restructuredtext.OptimizedReporter.debug
  pydoctor.epydoc.markup.restructuredtext.OptimizedReporter.html#debug
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring
  pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.html
  Class
  Class
  PUBLIC
  An encoded version of a ReStructuredText docstring. The contents of the docstring are encoded in the _document instance variable.
• pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
  pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring._document
  pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.html#_document
  Attribute
  Instance Variable
  PRIVATE
  A ReStructuredText document, encoding the docstring.
• pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.has_body
  pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.html#has_body
  Attribute
  Property
  PUBLIC
  Does this docstring have a non-empty body?
• pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.to_node
  pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.html#to_node
  Function
  Method
  PUBLIC
  Translate this docstring to a nodes.document.
• pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.__repr__
  pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._EpydocReader
  pydoctor.epydoc.markup.restructuredtext._EpydocReader.html
  Class
  Class
  PRIVATE
  A reader that captures all errors that are generated by parsing, and appends them to a list as ParseError.
• pydoctor.epydoc.markup.restructuredtext._EpydocReader.__init__
  pydoctor.epydoc.markup.restructuredtext._EpydocReader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._EpydocReader._errors
  pydoctor.epydoc.markup.restructuredtext._EpydocReader.html#_errors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._EpydocReader.get_transforms
  pydoctor.epydoc.markup.restructuredtext._EpydocReader.html#get_transforms
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._EpydocReader.new_document
  pydoctor.epydoc.markup.restructuredtext._EpydocReader.html#new_document
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._EpydocReader.report
  pydoctor.epydoc.markup.restructuredtext._EpydocReader.html#report
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._StrWriter
  pydoctor.epydoc.markup.restructuredtext.html#_StrWriter
  Attribute
  Type Alias
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter
  pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.html
  Class
  Class
  PRIVATE
  A pseudo-writer for the docutils framework, that can be used to access the document itself. The output of _DocumentPseudoWriter is just an empty string; but after it has been used, the most recently processed document is available as the instance variable ...
• pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.document
  pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.html#document
  Attribute
  Class Variable
  PUBLIC
  The most recently processed document.
• pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.translate
  pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.html#translate
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.output
  pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter.html#output
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html
  Class
  Class
  PRIVATE
  A docutils translator that removes all fields from a document, and collects them into the instance variable fields
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.fields
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#fields
  Attribute
  Instance Variable
  PUBLIC
  The fields of the most recently walked document.
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD
  Attribute
  Constant
  PUBLIC
  If true, then consolidated fields are not required to mark arguments with `backticks`. (This is currently only implemented for consolidated fields expressed as definition lists; consolidated fields expressed as unordered lists still require backticks for now.
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator._errors
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#_errors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator._newfields
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#_newfields
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.visit_document
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#visit_document
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.visit_field
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#visit_field
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator._add_field
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#_add_field
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.visit_field_list
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#visit_field_list
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_field
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#handle_consolidated_field
  Function
  Method
  PUBLIC
  Attempt to handle a consolidated section.
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_bullet_list
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#handle_consolidated_bullet_list
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_definition_list
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#handle_consolidated_definition_list
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.unknown_visit
  pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator.html#unknown_visit
  Function
  Method
  PUBLIC
  Ignore all unknown nodes
• pydoctor.epydoc.markup.restructuredtext.versionlabels
  pydoctor.epydoc.markup.restructuredtext.html#versionlabels
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.versionlabel_classes
  pydoctor.epydoc.markup.restructuredtext.html#versionlabel_classes
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.VersionChange
  pydoctor.epydoc.markup.restructuredtext.VersionChange.html
  Class
  Class
  PUBLIC
  Directive to describe a change/addition/deprecation in a specific version.
• pydoctor.epydoc.markup.restructuredtext.VersionChange.versionmodified
  pydoctor.epydoc.markup.restructuredtext.VersionChange.versionmodified.html
  Class
  Class
  PUBLIC
  Node for version change entries. Currently used for "versionadded", "versionchanged" and "deprecated" directives.
• pydoctor.epydoc.markup.restructuredtext.VersionChange.has_content
  pydoctor.epydoc.markup.restructuredtext.VersionChange.html#has_content
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.VersionChange.required_arguments
  pydoctor.epydoc.markup.restructuredtext.VersionChange.html#required_arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.VersionChange.optional_arguments
  pydoctor.epydoc.markup.restructuredtext.VersionChange.html#optional_arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.VersionChange.final_argument_whitespace
  pydoctor.epydoc.markup.restructuredtext.VersionChange.html#final_argument_whitespace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.VersionChange.run
  pydoctor.epydoc.markup.restructuredtext.VersionChange.html#run
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.SeeAlso
  pydoctor.epydoc.markup.restructuredtext.SeeAlso.html
  Class
  Class
  PUBLIC
  An admonition mentioning things to look at as reference.
• pydoctor.epydoc.markup.restructuredtext.SeeAlso.seealso
  pydoctor.epydoc.markup.restructuredtext.SeeAlso.seealso.html
  Class
  Class
  PUBLIC
  Custom "see also" admonition node.
• pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective
  pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective.html
  Class
  Class
  PUBLIC
  A custom restructuredtext directive which can be used to display syntax-highlighted Python code blocks. This directive takes no arguments, and the body should contain only Python code. This directive can be used instead of doctest blocks when it is inconvenient to list prompts on each line, or when you would prefer that the output not contain prompts (e...
• pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective.has_content
  pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective.html#has_content
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective.run
  pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective.html#run
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter
  pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.required_arguments
  pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.html#required_arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.optional_arguments
  pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.html#optional_arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.option_spec
  pydoctor.epydoc.markup.restructuredtext.DocutilsAndSphinxCodeBlockAdapter.html#option_spec
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.__version__
  pydoctor.epydoc.html#__version__
  Attribute
  Variable
  PUBLIC
  The version of epydoc
• pydoctor.epydoc.__author__
  pydoctor.epydoc.html#__author__
  Attribute
  Variable
  PUBLIC
  The primary author of eypdoc
• pydoctor.epydoc.__url__
  pydoctor.epydoc.html#__url__
  Attribute
  Variable
  PUBLIC
  The URL for epydoc's homepage
• pydoctor.epydoc.__license__
  pydoctor.epydoc.html#__license__
  Attribute
  Variable
  PUBLIC
  The license governing the use and distribution of epydoc
• pydoctor.epydoc.sre_constants36.MAGIC
  pydoctor.epydoc.sre_constants36.html#MAGIC
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36._MAXREPEAT
  pydoctor.epydoc.sre_constants36.html#_MAXREPEAT
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_constants36.MAXGROUPS
  pydoctor.epydoc.sre_constants36.html#MAXGROUPS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.error
  pydoctor.epydoc.sre_constants36.error.html
  Class
  Exception
  PUBLIC
  Exception raised for invalid regular expressions.
• pydoctor.epydoc.sre_constants36.error.__init__
  pydoctor.epydoc.sre_constants36.error.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.error.msg
  pydoctor.epydoc.sre_constants36.error.html#msg
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.error.pattern
  pydoctor.epydoc.sre_constants36.error.html#pattern
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.error.pos
  pydoctor.epydoc.sre_constants36.error.html#pos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.error.lineno
  pydoctor.epydoc.sre_constants36.error.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.error.colno
  pydoctor.epydoc.sre_constants36.error.html#colno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36._NamedIntConstant
  pydoctor.epydoc.sre_constants36._NamedIntConstant.html
  Class
  Class
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_constants36._NamedIntConstant.__new__
  pydoctor.epydoc.sre_constants36._NamedIntConstant.html#__new__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36._NamedIntConstant.name
  pydoctor.epydoc.sre_constants36._NamedIntConstant.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36._NamedIntConstant.__str__
  pydoctor.epydoc.sre_constants36._NamedIntConstant.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.MAXREPEAT
  pydoctor.epydoc.sre_constants36.html#MAXREPEAT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36._makecodes
  pydoctor.epydoc.sre_constants36.html#_makecodes
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_constants36.OPCODES
  pydoctor.epydoc.sre_constants36.html#OPCODES
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.ATCODES
  pydoctor.epydoc.sre_constants36.html#ATCODES
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.CHCODES
  pydoctor.epydoc.sre_constants36.html#CHCODES
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.OP_IGNORE
  pydoctor.epydoc.sre_constants36.html#OP_IGNORE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.AT_MULTILINE
  pydoctor.epydoc.sre_constants36.html#AT_MULTILINE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.AT_LOCALE
  pydoctor.epydoc.sre_constants36.html#AT_LOCALE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.AT_UNICODE
  pydoctor.epydoc.sre_constants36.html#AT_UNICODE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.CH_LOCALE
  pydoctor.epydoc.sre_constants36.html#CH_LOCALE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.CH_UNICODE
  pydoctor.epydoc.sre_constants36.html#CH_UNICODE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_TEMPLATE
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_TEMPLATE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_IGNORECASE
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_IGNORECASE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_LOCALE
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_LOCALE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_MULTILINE
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_MULTILINE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_DOTALL
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_DOTALL
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_UNICODE
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_UNICODE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_VERBOSE
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_VERBOSE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_DEBUG
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_DEBUG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_FLAG_ASCII
  pydoctor.epydoc.sre_constants36.html#SRE_FLAG_ASCII
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_INFO_PREFIX
  pydoctor.epydoc.sre_constants36.html#SRE_INFO_PREFIX
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_INFO_LITERAL
  pydoctor.epydoc.sre_constants36.html#SRE_INFO_LITERAL
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_constants36.SRE_INFO_CHARSET
  pydoctor.epydoc.sre_constants36.html#SRE_INFO_CHARSET
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SPECIAL_CHARS
  pydoctor.epydoc.sre_parse36.html#SPECIAL_CHARS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.REPEAT_CHARS
  pydoctor.epydoc.sre_parse36.html#REPEAT_CHARS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.DIGITS
  pydoctor.epydoc.sre_parse36.html#DIGITS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.OCTDIGITS
  pydoctor.epydoc.sre_parse36.html#OCTDIGITS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.HEXDIGITS
  pydoctor.epydoc.sre_parse36.html#HEXDIGITS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.ASCIILETTERS
  pydoctor.epydoc.sre_parse36.html#ASCIILETTERS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.WHITESPACE
  pydoctor.epydoc.sre_parse36.html#WHITESPACE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36._REPEATCODES
  pydoctor.epydoc.sre_parse36.html#_REPEATCODES
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36._UNITCODES
  pydoctor.epydoc.sre_parse36.html#_UNITCODES
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36.ESCAPES
  pydoctor.epydoc.sre_parse36.html#ESCAPES
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.CATEGORIES
  pydoctor.epydoc.sre_parse36.html#CATEGORIES
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.FLAGS
  pydoctor.epydoc.sre_parse36.html#FLAGS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.GLOBAL_FLAGS
  pydoctor.epydoc.sre_parse36.html#GLOBAL_FLAGS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Verbose
  pydoctor.epydoc.sre_parse36.Verbose.html
  Class
  Exception
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern
  pydoctor.epydoc.sre_parse36.Pattern.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.__init__
  pydoctor.epydoc.sre_parse36.Pattern.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.flags
  pydoctor.epydoc.sre_parse36.Pattern.html#flags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.groupdict
  pydoctor.epydoc.sre_parse36.Pattern.html#groupdict
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.groupwidths
  pydoctor.epydoc.sre_parse36.Pattern.html#groupwidths
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.lookbehindgroups
  pydoctor.epydoc.sre_parse36.Pattern.html#lookbehindgroups
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.groups
  pydoctor.epydoc.sre_parse36.Pattern.html#groups
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.opengroup
  pydoctor.epydoc.sre_parse36.Pattern.html#opengroup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.closegroup
  pydoctor.epydoc.sre_parse36.Pattern.html#closegroup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.checkgroup
  pydoctor.epydoc.sre_parse36.Pattern.html#checkgroup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Pattern.checklookbehindgroup
  pydoctor.epydoc.sre_parse36.Pattern.html#checklookbehindgroup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern
  pydoctor.epydoc.sre_parse36.SubPattern.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.__init__
  pydoctor.epydoc.sre_parse36.SubPattern.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.pattern
  pydoctor.epydoc.sre_parse36.SubPattern.html#pattern
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.data
  pydoctor.epydoc.sre_parse36.SubPattern.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.width
  pydoctor.epydoc.sre_parse36.SubPattern.html#width
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.dump
  pydoctor.epydoc.sre_parse36.SubPattern.html#dump
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.__repr__
  pydoctor.epydoc.sre_parse36.SubPattern.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.__len__
  pydoctor.epydoc.sre_parse36.SubPattern.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.__delitem__
  pydoctor.epydoc.sre_parse36.SubPattern.html#__delitem__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.__getitem__
  pydoctor.epydoc.sre_parse36.SubPattern.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.__setitem__
  pydoctor.epydoc.sre_parse36.SubPattern.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.insert
  pydoctor.epydoc.sre_parse36.SubPattern.html#insert
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.append
  pydoctor.epydoc.sre_parse36.SubPattern.html#append
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.SubPattern.getwidth
  pydoctor.epydoc.sre_parse36.SubPattern.html#getwidth
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer
  pydoctor.epydoc.sre_parse36.Tokenizer.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.__init__
  pydoctor.epydoc.sre_parse36.Tokenizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.istext
  pydoctor.epydoc.sre_parse36.Tokenizer.html#istext
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.string
  pydoctor.epydoc.sre_parse36.Tokenizer.html#string
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.decoded_string
  pydoctor.epydoc.sre_parse36.Tokenizer.html#decoded_string
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.index
  pydoctor.epydoc.sre_parse36.Tokenizer.html#index
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.next
  pydoctor.epydoc.sre_parse36.Tokenizer.html#next
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.__next
  pydoctor.epydoc.sre_parse36.Tokenizer.html#__next
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.match
  pydoctor.epydoc.sre_parse36.Tokenizer.html#match
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.get
  pydoctor.epydoc.sre_parse36.Tokenizer.html#get
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.getwhile
  pydoctor.epydoc.sre_parse36.Tokenizer.html#getwhile
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.getuntil
  pydoctor.epydoc.sre_parse36.Tokenizer.html#getuntil
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.pos
  pydoctor.epydoc.sre_parse36.Tokenizer.html#pos
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.tell
  pydoctor.epydoc.sre_parse36.Tokenizer.html#tell
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.seek
  pydoctor.epydoc.sre_parse36.Tokenizer.html#seek
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.Tokenizer.error
  pydoctor.epydoc.sre_parse36.Tokenizer.html#error
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36._class_escape
  pydoctor.epydoc.sre_parse36.html#_class_escape
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36._escape
  pydoctor.epydoc.sre_parse36.html#_escape
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36._parse_sub
  pydoctor.epydoc.sre_parse36.html#_parse_sub
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36._parse_sub_cond
  pydoctor.epydoc.sre_parse36.html#_parse_sub_cond
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36._parse
  pydoctor.epydoc.sre_parse36.html#_parse
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36._parse_flags
  pydoctor.epydoc.sre_parse36.html#_parse_flags
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.sre_parse36.fix_flags
  pydoctor.epydoc.sre_parse36.html#fix_flags
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.parse
  pydoctor.epydoc.sre_parse36.html#parse
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.parse_template
  pydoctor.epydoc.sre_parse36.html#parse_template
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc.sre_parse36.expand_template
  pydoctor.epydoc.sre_parse36.html#expand_template
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.decode_with_backslashreplace
  pydoctor.epydoc.markup._pyval_repr.html#decode_with_backslashreplace
  Function
  Function
  PUBLIC
  Convert the given 8-bit string into unicode, treating any character c such that ord(c)<128 as an ascii character, and converting any c such that ord(c)>128 into a backslashed escape sequence.
• pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState
  pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.html
  Class
  Class
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.length
  pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.html#length
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.charpos
  pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.html#charpos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.lineno
  pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.linebreakok
  pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.html#linebreakok
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.stacklength
  pydoctor.epydoc.markup._pyval_repr._MarkedColorizerState.html#stacklength
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html
  Class
  Class
  PRIVATE
  An object uesd to keep track of the current state of the pyval colorizer. The mark()/restore() methods can be used to set a backup point, and restore back to that backup point. This is used by several colorization methods that first try colorizing their object on a single line (setting linebreakok=False); and then fall back on a multi-line output if that fails.
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.__init__
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.result
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.charpos
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#charpos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.lineno
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.linebreakok
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#linebreakok
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.warnings
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.stack
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#stack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.mark
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#mark
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._ColorizerState.restore
  pydoctor.epydoc.markup._pyval_repr._ColorizerState.html#restore
  Function
  Method
  PUBLIC
  Return what's been trimmed from the result.
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html
  Class
  Class
  PRIVATE
  A context manager that can add enclosing delimiters to nested operators when needed.
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.__init__
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.discard
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#discard
  Attribute
  Instance Variable
  PUBLIC
  No parenthesis by default.
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.colorizer
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#colorizer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.state
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.marked
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#marked
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.__enter__
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#__enter__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.__exit__
  pydoctor.epydoc.markup._pyval_repr._OperatorDelimiter.html#__exit__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._Maxlines
  pydoctor.epydoc.markup._pyval_repr._Maxlines.html
  Class
  Exception
  PRIVATE
  A control-flow exception that is raised when PyvalColorizer exeeds the maximum number of allowed lines.
• pydoctor.epydoc.markup._pyval_repr._Linebreak
  pydoctor.epydoc.markup._pyval_repr._Linebreak.html
  Class
  Exception
  PRIVATE
  A control-flow exception that is raised when PyvalColorizer generates a string containing a newline, but the state object's linebreakok variable is False.
• pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr
  pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.html
  Class
  Class
  PUBLIC
  No summary
• pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.is_complete
  pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.html#is_complete
  Attribute
  Instance Variable
  PUBLIC
  True if this colorized repr completely describes the object.
• pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.__init__
  pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.warnings
  pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  List of warnings
• pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.to_stan
  pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr.html#to_stan
  Function
  Method
  PUBLIC
  Translate this docstring to a Stan tree.
• pydoctor.epydoc.markup._pyval_repr.colorize_pyval
  pydoctor.epydoc.markup._pyval_repr.html#colorize_pyval
  Function
  Function
  PUBLIC
  Get a ColorizedPyvalRepr instance for this piece of ast.
• pydoctor.epydoc.markup._pyval_repr.colorize_inline_pyval
  pydoctor.epydoc.markup._pyval_repr.html#colorize_inline_pyval
  Function
  Function
  PUBLIC
  Used to colorize type annotations and parameters default values.
• pydoctor.epydoc.markup._pyval_repr._get_str_func
  pydoctor.epydoc.markup._pyval_repr.html#_get_str_func
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr._str_escape
  pydoctor.epydoc.markup._pyval_repr.html#_str_escape
  Function
  Function
  PRIVATE
  Encode a string such that it's correctly represented inside simple quotes.
• pydoctor.epydoc.markup._pyval_repr._bytes_escape
  pydoctor.epydoc.markup._pyval_repr.html#_bytes_escape
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html
  Class
  Class
  PUBLIC
  Syntax highlighter for Python AST (and some builtins types).
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.__init__
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.linelen
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#linelen
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.maxlines
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#maxlines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.linebreakok
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#linebreakok
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.refmap
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#refmap
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.is_annotation
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#is_annotation
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.explicit_precedence
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#explicit_precedence
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.GROUP_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#GROUP_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.COMMA_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#COMMA_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.COLON_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#COLON_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.CONST_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#CONST_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.NUMBER_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#NUMBER_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.QUOTE_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#QUOTE_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.STRING_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#STRING_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.LINK_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#LINK_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.ELLIPSIS_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#ELLIPSIS_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.LINEWRAP_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#LINEWRAP_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.UNKNOWN_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#UNKNOWN_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.RE_CHAR_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#RE_CHAR_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.RE_GROUP_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#RE_GROUP_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.RE_REF_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#RE_REF_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.RE_OP_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#RE_OP_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.RE_FLAGS_TAG
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#RE_FLAGS_TAG
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.ELLIPSIS
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#ELLIPSIS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.LINEWRAP
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#LINEWRAP
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.UNKNOWN_REPR
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#UNKNOWN_REPR
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.WORD_BREAK_OPPORTUNITY
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#WORD_BREAK_OPPORTUNITY
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.NEWLINE
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#NEWLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.GENERIC_OBJECT_RE
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#GENERIC_OBJECT_RE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.RE_COMPILE_SIGNATURE
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#RE_COMPILE_SIGNATURE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._set_precedence
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_set_precedence
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.colorize
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#colorize
  Function
  Method
  PUBLIC
  Entry Point.
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._trim_result
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_trim_result
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._insert_comma
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_insert_comma
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._multiline
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_multiline
  Function
  Method
  PRIVATE
  Helper for container-type colorizers. First, try calling func(pyval, state, **kwargs) with linebreakok set to false; and if that fails, then try again with it set to true.
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_iter
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_iter
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_dict
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_dict
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_str
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_str
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_constant
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_constant
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_unary_op
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_unary_op
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_binary_op
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_binary_op
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_bool_op
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_bool_op
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_name
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_name
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_attribute
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_attribute
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_subscript
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_subscript
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_call
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_call
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_call_generic
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_call_generic
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_re
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_re
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_ast_generic
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_ast_generic
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_re_pattern_str
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_re_pattern_str
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_re_pattern
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_re_pattern
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_re_flags
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_re_flags
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._colorize_re_tree
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_colorize_re_tree
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._pyval_repr.PyvalColorizer._output
  pydoctor.epydoc.markup._pyval_repr.PyvalColorizer.html#_output
  Function
  Method
  PRIVATE
  Add the string s to the result list, tagging its contents with the specified css_class. Any lines that go beyond PyvalColorizer.linelen will be line-wrapped. If the total number of lines exceeds PyvalColorizer.maxlines...
• pydoctor.epydoc2stan.BROKEN_TEXT
  pydoctor.epydoc2stan.html#BROKEN_TEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.BROKEN
  pydoctor.epydoc2stan.html#BROKEN
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan._get_docformat
  pydoctor.epydoc2stan.html#_get_docformat
  Function
  Function
  PRIVATE
  Returns the docformat to use to parse the docstring of this object.
• pydoctor.epydoc2stan.FieldDesc
  pydoctor.epydoc2stan.FieldDesc.html
  Class
  Class
  PUBLIC
  Combines informations from multiple Field objects into one.
• pydoctor.epydoc2stan.FieldDesc._UNDOCUMENTED
  pydoctor.epydoc2stan.FieldDesc.html#_UNDOCUMENTED
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan.FieldDesc.name
  pydoctor.epydoc2stan.FieldDesc.html#name
  Attribute
  Instance Variable
  PUBLIC
  Field name, i.e. :param <name>:
• pydoctor.epydoc2stan.FieldDesc.type
  pydoctor.epydoc2stan.FieldDesc.html#type
  Attribute
  Instance Variable
  PUBLIC
  Formatted type
• pydoctor.epydoc2stan.FieldDesc.body
  pydoctor.epydoc2stan.FieldDesc.html#body
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldDesc.format
  pydoctor.epydoc2stan.FieldDesc.html#format
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc2stan._SignatureDesc
  pydoctor.epydoc2stan._SignatureDesc.html
  Class
  Class
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan._SignatureDesc.type_origin
  pydoctor.epydoc2stan._SignatureDesc.html#type_origin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan._SignatureDesc.is_documented
  pydoctor.epydoc2stan._SignatureDesc.html#is_documented
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.ReturnDesc
  pydoctor.epydoc2stan.ReturnDesc.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.ParamDesc
  pydoctor.epydoc2stan.ParamDesc.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.KeywordDesc
  pydoctor.epydoc2stan.KeywordDesc.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.RaisesDesc
  pydoctor.epydoc2stan.RaisesDesc.html
  Class
  Class
  PUBLIC
  Description of an exception that can be raised by function/method.
• pydoctor.epydoc2stan.RaisesDesc.format
  pydoctor.epydoc2stan.RaisesDesc.html#format
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc2stan.format_desc_list
  pydoctor.epydoc2stan.html#format_desc_list
  Function
  Function
  PUBLIC
  Format list of FieldDesc. Used for param, returns, raises, etc.
• pydoctor.epydoc2stan.Field
  pydoctor.epydoc2stan.Field.html
  Class
  Class
  PUBLIC
  Like pydoctor.epydoc.markup.Field, but without the gross accessor methods and with a formatted body.
• pydoctor.epydoc2stan.Field.tag
  pydoctor.epydoc2stan.Field.html#tag
  Attribute
  Instance Variable
  PUBLIC
  Field tag, i.e. :<tag>:
• pydoctor.epydoc2stan.Field.arg
  pydoctor.epydoc2stan.Field.html#arg
  Attribute
  Instance Variable
  PUBLIC
  Field argument, i.e. :param <argument>:
• pydoctor.epydoc2stan.Field.source
  pydoctor.epydoc2stan.Field.html#source
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.Field.lineno
  pydoctor.epydoc2stan.Field.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.Field.body
  pydoctor.epydoc2stan.Field.html#body
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.Field.from_epydoc
  pydoctor.epydoc2stan.Field.html#from_epydoc
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.Field.format
  pydoctor.epydoc2stan.Field.html#format
  Function
  Method
  PUBLIC
  Present this field's body as HTML.
• pydoctor.epydoc2stan.Field.report
  pydoctor.epydoc2stan.Field.html#report
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.format_field_list
  pydoctor.epydoc2stan.html#format_field_list
  Function
  Function
  PUBLIC
  Format list of Field object. Used for notes, see also, authors, etc.
• pydoctor.epydoc2stan.VariableArgument
  pydoctor.epydoc2stan.VariableArgument.html
  Class
  Class
  PUBLIC
  Encapsulate the name of vararg parameters in Function.annotations mapping keys.
• pydoctor.epydoc2stan.KeywordArgument
  pydoctor.epydoc2stan.KeywordArgument.html
  Class
  Class
  PUBLIC
  Encapsulate the name of kwarg parameters in Function.annotations mapping keys.
• pydoctor.epydoc2stan.FieldOrigin
  pydoctor.epydoc2stan.FieldOrigin.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldOrigin.FROM_AST
  pydoctor.epydoc2stan.FieldOrigin.html#FROM_AST
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldOrigin.FROM_DOCSTRING
  pydoctor.epydoc2stan.FieldOrigin.html#FROM_DOCSTRING
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.ParamType
  pydoctor.epydoc2stan.ParamType.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.ParamType.stan
  pydoctor.epydoc2stan.ParamType.html#stan
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.ParamType.origin
  pydoctor.epydoc2stan.ParamType.html#origin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler
  pydoctor.epydoc2stan.FieldHandler.html
  Class
  Class
  PUBLIC
  No class docstring; 0/13 instance variable, 3/22 methods, 0/1 static method documented
• pydoctor.epydoc2stan.FieldHandler.__init__
  pydoctor.epydoc2stan.FieldHandler.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.obj
  pydoctor.epydoc2stan.FieldHandler.html#obj
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler._linker
  pydoctor.epydoc2stan.FieldHandler.html#_linker
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.types
  pydoctor.epydoc2stan.FieldHandler.html#types
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.parameter_descs
  pydoctor.epydoc2stan.FieldHandler.html#parameter_descs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.return_desc
  pydoctor.epydoc2stan.FieldHandler.html#return_desc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.yields_desc
  pydoctor.epydoc2stan.FieldHandler.html#yields_desc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.raise_descs
  pydoctor.epydoc2stan.FieldHandler.html#raise_descs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.warns_desc
  pydoctor.epydoc2stan.FieldHandler.html#warns_desc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.seealsos
  pydoctor.epydoc2stan.FieldHandler.html#seealsos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.notes
  pydoctor.epydoc2stan.FieldHandler.html#notes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.authors
  pydoctor.epydoc2stan.FieldHandler.html#authors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.sinces
  pydoctor.epydoc2stan.FieldHandler.html#sinces
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.unknowns
  pydoctor.epydoc2stan.FieldHandler.html#unknowns
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.set_param_types_from_annotations
  pydoctor.epydoc2stan.FieldHandler.html#set_param_types_from_annotations
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler._report_unexpected_argument
  pydoctor.epydoc2stan.FieldHandler.html#_report_unexpected_argument
  Function
  Static Method
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_return
  pydoctor.epydoc2stan.FieldHandler.html#handle_return
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_yield
  pydoctor.epydoc2stan.FieldHandler.html#handle_yield
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_returntype
  pydoctor.epydoc2stan.FieldHandler.html#handle_returntype
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_yieldtype
  pydoctor.epydoc2stan.FieldHandler.html#handle_yieldtype
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler._handle_param_name
  pydoctor.epydoc2stan.FieldHandler.html#_handle_param_name
  Function
  Method
  PRIVATE
  Returns the Field name and trigger a few warnings for a few scenarios. Note that the return type could be VariableArgument or KeywordArgument or str.
• pydoctor.epydoc2stan.FieldHandler._handle_param_not_found
  pydoctor.epydoc2stan.FieldHandler.html#_handle_param_not_found
  Function
  Method
  PRIVATE
  Figure out if the parameter might exist despite not being found in this documentable's code, warn if not.
• pydoctor.epydoc2stan.FieldHandler.handle_type
  pydoctor.epydoc2stan.FieldHandler.html#handle_type
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_param
  pydoctor.epydoc2stan.FieldHandler.html#handle_param
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_keyword
  pydoctor.epydoc2stan.FieldHandler.html#handle_keyword
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handled_elsewhere
  pydoctor.epydoc2stan.FieldHandler.html#handled_elsewhere
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_raises
  pydoctor.epydoc2stan.FieldHandler.html#handle_raises
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_warns
  pydoctor.epydoc2stan.FieldHandler.html#handle_warns
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_seealso
  pydoctor.epydoc2stan.FieldHandler.html#handle_seealso
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_note
  pydoctor.epydoc2stan.FieldHandler.html#handle_note
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_author
  pydoctor.epydoc2stan.FieldHandler.html#handle_author
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle_since
  pydoctor.epydoc2stan.FieldHandler.html#handle_since
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handleUnknownField
  pydoctor.epydoc2stan.FieldHandler.html#handleUnknownField
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.handle
  pydoctor.epydoc2stan.FieldHandler.html#handle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.FieldHandler.resolve_types
  pydoctor.epydoc2stan.FieldHandler.html#resolve_types
  Function
  Method
  PUBLIC
  Merge information from 'param'/'keyword' fields and AST analysis.
• pydoctor.epydoc2stan.FieldHandler.format
  pydoctor.epydoc2stan.FieldHandler.html#format
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.reportWarnings
  pydoctor.epydoc2stan.html#reportWarnings
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.reportErrors
  pydoctor.epydoc2stan.html#reportErrors
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan._objclass
  pydoctor.epydoc2stan.html#_objclass
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan._docformat_skip_processtypes
  pydoctor.epydoc2stan.html#_docformat_skip_processtypes
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan.parse_docstring
  pydoctor.epydoc2stan.html#parse_docstring
  Function
  Function
  PUBLIC
  Parse a docstring.
• pydoctor.epydoc2stan.ensure_parsed_docstring
  pydoctor.epydoc2stan.html#ensure_parsed_docstring
  Function
  Function
  PUBLIC
  Currently, it's not 100% clear at what point the Documentable.parsed_docstring attribute is set. It can be set from the ast builder or later processing step.
• pydoctor.epydoc2stan._get_parsed_summary
  pydoctor.epydoc2stan.html#_get_parsed_summary
  Function
  Function
  PRIVATE
  Ensures that the model.Documentable.parsed_summary attribute of a documentable is set to it's final value. Do not generate summary twice.
• pydoctor.epydoc2stan.get_to_stan_error
  pydoctor.epydoc2stan.html#get_to_stan_error
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.safe_to_stan
  pydoctor.epydoc2stan.html#safe_to_stan
  Function
  Function
  PUBLIC
  Wraps ParsedDocstring.to_stan() to catch exception and handle them in fallback. This is used to convert docstrings as well as other colorized AST values to stan.
• pydoctor.epydoc2stan.format_docstring_fallback
  pydoctor.epydoc2stan.html#format_docstring_fallback
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan._wrap_in_paragraph
  pydoctor.epydoc2stan.html#_wrap_in_paragraph
  Function
  Function
  PRIVATE
  Whether to wrap the given docstring stan body inside a paragraph.
• pydoctor.epydoc2stan.unwrap_docstring_stan
  pydoctor.epydoc2stan.html#unwrap_docstring_stan
  Function
  Function
  PUBLIC
  Unwrap the body of the given Tag instance if it has a non-empty tag name and ensure there is at least one paragraph.
• pydoctor.epydoc2stan.format_docstring
  pydoctor.epydoc2stan.html#format_docstring
  Function
  Function
  PUBLIC
  Generate an HTML representation of a docstring
• pydoctor.epydoc2stan.format_summary_fallback
  pydoctor.epydoc2stan.html#format_summary_fallback
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.format_summary
  pydoctor.epydoc2stan.html#format_summary
  Function
  Function
  PUBLIC
  Generate an shortened HTML representation of a docstring.
• pydoctor.epydoc2stan.format_undocumented_summary
  pydoctor.epydoc2stan.html#format_undocumented_summary
  Function
  Function
  PUBLIC
  Generate a string representation for an object lacking a docstring.
• pydoctor.epydoc2stan.type2stan
  pydoctor.epydoc2stan.html#type2stan
  Function
  Function
  PUBLIC
  Get the formatted type of this attribute.
• pydoctor.epydoc2stan.get_parsed_type
  pydoctor.epydoc2stan.html#get_parsed_type
  Function
  Function
  PUBLIC
  Get the type of this attribute as parsed docstring.
• pydoctor.epydoc2stan.format_toc
  pydoctor.epydoc2stan.html#format_toc
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.field_name_to_kind
  pydoctor.epydoc2stan.html#field_name_to_kind
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.extract_fields
  pydoctor.epydoc2stan.html#extract_fields
  Function
  Function
  PUBLIC
  Populate Attributes for module/class variables using fields from that module/class's docstring. Must only be called for objects that have a docstring.
• pydoctor.epydoc2stan.format_kind
  pydoctor.epydoc2stan.html#format_kind
  Function
  Function
  PUBLIC
  Transform a `model.DocumentableKind` Enum value to string.
• pydoctor.epydoc2stan.colorized_pyval_fallback
  pydoctor.epydoc2stan.html#colorized_pyval_fallback
  Function
  Function
  PUBLIC
  This fallback function uses ParsedDocstring.to_node(), so it must be used only with ParsedDocstring subclasses that implements to_node().
• pydoctor.epydoc2stan._format_constant_value
  pydoctor.epydoc2stan.html#_format_constant_value
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan.format_constant_value
  pydoctor.epydoc2stan.html#format_constant_value
  Function
  Function
  PUBLIC
  Should be only called for Attribute objects that have the Attribute.value property set.
• pydoctor.epydoc2stan._split_indentifier_parts_on_case
  pydoctor.epydoc2stan.html#_split_indentifier_parts_on_case
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc2stan.insert_break_points
  pydoctor.epydoc2stan.html#insert_break_points
  Function
  Function
  PUBLIC
  Browsers aren't smart enough to recognize word breaking opportunities in snake_case or camelCase, so this function helps them out by inserting word break opportunities.
• pydoctor.epydoc2stan.format_constructor_short_text
  pydoctor.epydoc2stan.html#format_constructor_short_text
  Function
  Function
  PUBLIC
  Returns a simplified signature of the constructor. forclass is not always the function's parent, it can be a subclass.
• pydoctor.epydoc2stan.get_constructors_extra
  pydoctor.epydoc2stan.html#get_constructors_extra
  Function
  Function
  PUBLIC
  Get an extra docstring to represent Class constructors.
• pydoctor.epydoc2stan.get_namespace_docstring
  pydoctor.epydoc2stan.html#get_namespace_docstring
  Function
  Function
  PUBLIC
  Get a useful description about this namespace package.
• pydoctor.epydoc2stan._colorize_signature_annotation
  pydoctor.epydoc2stan.html#_colorize_signature_annotation
  Function
  Function
  PRIVATE
  Returns this annotation as a list of nodes
• pydoctor.epydoc2stan._is_less_important_param
  pydoctor.epydoc2stan.html#_is_less_important_param
  Function
  Function
  PRIVATE
  Whether this parameter is the 'self' param of methods or 'cls' param of class methods.
• pydoctor.epydoc2stan._colorize_signature_param
  pydoctor.epydoc2stan.html#_colorize_signature_param
  Function
  Function
  PRIVATE
  Convert a single parameter to a docutils inline element.
• pydoctor.epydoc2stan._colorize_signature
  pydoctor.epydoc2stan.html#_colorize_signature
  Function
  Function
  PRIVATE
  Colorize this signature into a ParsedDocstring.
• pydoctor.epydoc2stan.get_parsed_signature
  pydoctor.epydoc2stan.html#get_parsed_signature
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.epydoc2stan.function_signature_len
  pydoctor.epydoc2stan.html#function_signature_len
  Function
  Function
  PUBLIC
  The lenght of the a function def is defnied by the lenght of it's name plus the lenght of it's signature. On top of that, a function or method that takes no argument (expect unannotated 'self' for methods, and 'cls' for classmethods) will always have a lenght equals to the function name len plus two for 'function()'.
• pydoctor.extensions.ClassMixin
  pydoctor.extensions.ClassMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Class objects.
• pydoctor.extensions.ModuleMixin
  pydoctor.extensions.ModuleMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Module objects.
• pydoctor.extensions.PackageMixin
  pydoctor.extensions.PackageMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Package objects.
• pydoctor.extensions.FunctionMixin
  pydoctor.extensions.FunctionMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Function objects.
• pydoctor.extensions.AttributeMixin
  pydoctor.extensions.AttributeMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Attribute objects.
• pydoctor.extensions.DocumentableMixin
  pydoctor.extensions.DocumentableMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to all model.Documentable objects.
• pydoctor.extensions.CanContainImportsDocumentableMixin
  pydoctor.extensions.CanContainImportsDocumentableMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Class, model.Module and model.Package objects.
• pydoctor.extensions.InheritableMixin
  pydoctor.extensions.InheritableMixin.html
  Class
  Class
  PUBLIC
  Base class for mixins applied to model.Function and model.Attribute objects.
• pydoctor.extensions.MixinT
  pydoctor.extensions.html#MixinT
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• pydoctor.extensions._importlib_resources_contents
  pydoctor.extensions.html#_importlib_resources_contents
  Function
  Function
  PRIVATE
  Return an iterable of entries in package.
• pydoctor.extensions._importlib_resources_is_resource
  pydoctor.extensions.html#_importlib_resources_is_resource
  Function
  Function
  PRIVATE
  True if name is a resource inside package.
• pydoctor.extensions._get_submodules
  pydoctor.extensions.html#_get_submodules
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.extensions._get_setup_extension_func_from_module
  pydoctor.extensions.html#_get_setup_extension_func_from_module
  Function
  Function
  PRIVATE
  Will look for the special function setup_pydoctor_extension in the provided module.
• pydoctor.extensions._mixin_to_class_name
  pydoctor.extensions.html#_mixin_to_class_name
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.extensions._get_mixins
  pydoctor.extensions.html#_get_mixins
  Function
  Function
  PRIVATE
  Transform a list of mixins classes to a dict from the concrete class name to the mixins that must be applied to it. This relies on the fact that mixins shoud extend one of the base mixin classes in pydoctor.extensions...
• pydoctor.extensions.DEFAULT_PRIORITY
  pydoctor.extensions.html#DEFAULT_PRIORITY
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.extensions.PriorityProcessor
  pydoctor.extensions.PriorityProcessor.html
  Class
  Class
  PUBLIC
  Stores Callable and applies them to the system based on priority or insertion order. The default priority is 100, see code source of astbuilder.setup_pydoctor_extension, and others setup_pydoctor_extension...
• pydoctor.extensions.PriorityProcessor.__init__
  pydoctor.extensions.PriorityProcessor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.PriorityProcessor.system
  pydoctor.extensions.PriorityProcessor.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.PriorityProcessor.applied
  pydoctor.extensions.PriorityProcessor.html#applied
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.PriorityProcessor._post_processors
  pydoctor.extensions.PriorityProcessor.html#_post_processors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.extensions.PriorityProcessor._counter
  pydoctor.extensions.PriorityProcessor.html#_counter
  Attribute
  Instance Variable
  PRIVATE
  Internal counter to keep track of the add order of callables.
• pydoctor.extensions.PriorityProcessor.add_post_processor
  pydoctor.extensions.PriorityProcessor.html#add_post_processor
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.PriorityProcessor._get_priority_key
  pydoctor.extensions.PriorityProcessor.html#_get_priority_key
  Function
  Method
  PRIVATE
  Return a tuple, `priority` combined with `self._counter`.
• pydoctor.extensions.PriorityProcessor.apply_processors
  pydoctor.extensions.PriorityProcessor.html#apply_processors
  Function
  Method
  PUBLIC
  Apply all of the stored processors, in priority order.
• pydoctor.extensions.ExtRegistrar
  pydoctor.extensions.ExtRegistrar.html
  Class
  Class
  PUBLIC
  The extension registrar class provides utilites to register an extension's components.
• pydoctor.extensions.ExtRegistrar.system
  pydoctor.extensions.ExtRegistrar.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.ExtRegistrar.register_mixin
  pydoctor.extensions.ExtRegistrar.html#register_mixin
  Function
  Method
  PUBLIC
  Register mixin for model objects. Mixins shoud extend one of the base mixin classes in pydoctor.extensions module, i.e. ClassMixin or DocumentableMixin, etc.
• pydoctor.extensions.ExtRegistrar.register_astbuilder_visitor
  pydoctor.extensions.ExtRegistrar.html#register_astbuilder_visitor
  Function
  Method
  PUBLIC
  Register AST visitor(s). Typically visitor extensions inherits from ModuleVisitorExt.
• pydoctor.extensions.ExtRegistrar.register_post_processor
  pydoctor.extensions.ExtRegistrar.html#register_post_processor
  Function
  Method
  PUBLIC
  Register post processor(s).
• pydoctor.extensions.load_extension_module
  pydoctor.extensions.html#load_extension_module
  Function
  Function
  PUBLIC
  Load the pydoctor extension module into the system.
• pydoctor.extensions.get_extensions
  pydoctor.extensions.html#get_extensions
  Function
  Function
  PUBLIC
  Get the full names of all the pydoctor extension modules.
• pydoctor.extensions.ModuleVisitorExt
  pydoctor.extensions.ModuleVisitorExt.html
  Class
  Class
  PUBLIC
  Base class to extend the astbuilder.ModuleVistor.
• pydoctor.extensions.ModuleVisitorExt.visitor
  pydoctor.extensions.ModuleVisitorExt.html#visitor
  Attribute
  Instance Variable
  PUBLIC
  The parent visitor
• pydoctor.tokenutils.Token
  pydoctor.tokenutils.Token.html
  Class
  Class
  PUBLIC
  Better token wrapper for tokenize module.
• pydoctor.tokenutils.Token.__init__
  pydoctor.tokenutils.Token.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.kind
  pydoctor.tokenutils.Token.html#kind
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.value
  pydoctor.tokenutils.Token.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.start
  pydoctor.tokenutils.Token.html#start
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.end
  pydoctor.tokenutils.Token.html#end
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.source
  pydoctor.tokenutils.Token.html#source
  Attribute
  Instance Variable
  PUBLIC
  Source line
• pydoctor.tokenutils.Token.__eq__
  pydoctor.tokenutils.Token.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.match
  pydoctor.tokenutils.Token.html#match
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.tokenutils.Token.__repr__
  pydoctor.tokenutils.Token.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.tokenutils.TokenProcessor
  pydoctor.tokenutils.TokenProcessor.html
  Class
  Class
  PUBLIC
  Processes tokens from source code lines.
• pydoctor.tokenutils.TokenProcessor.__init__
  pydoctor.tokenutils.TokenProcessor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.tokenutils.TokenProcessor.buffers
  pydoctor.tokenutils.TokenProcessor.html#buffers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.TokenProcessor.tokens
  pydoctor.tokenutils.TokenProcessor.html#tokens
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.TokenProcessor.current
  pydoctor.tokenutils.TokenProcessor.html#current
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.TokenProcessor.previous
  pydoctor.tokenutils.TokenProcessor.html#previous
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.TokenProcessor.get_line
  pydoctor.tokenutils.TokenProcessor.html#get_line
  Function
  Method
  PUBLIC
  Returns specified line.
• pydoctor.tokenutils.TokenProcessor.fetch_token
  pydoctor.tokenutils.TokenProcessor.html#fetch_token
  Function
  Method
  PUBLIC
  Fetch a next token from source code.
• pydoctor.tokenutils.TokenProcessor.fetch_until
  pydoctor.tokenutils.TokenProcessor.html#fetch_until
  Function
  Method
  PUBLIC
  Fetch tokens until specified token appeared.
• pydoctor.tokenutils.AfterCommentParser
  pydoctor.tokenutils.AfterCommentParser.html
  Class
  Class
  PUBLIC
  Python source code parser to pick up comment after assignment.
• pydoctor.tokenutils.AfterCommentParser.__init__
  pydoctor.tokenutils.AfterCommentParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.tokenutils.AfterCommentParser.comment
  pydoctor.tokenutils.AfterCommentParser.html#comment
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.AfterCommentParser.fetch_rvalue
  pydoctor.tokenutils.AfterCommentParser.html#fetch_rvalue
  Function
  Method
  PUBLIC
  Fetch right-hand value of assignment.
• pydoctor.tokenutils.AfterCommentParser.parse
  pydoctor.tokenutils.AfterCommentParser.html#parse
  Function
  Method
  PUBLIC
  Parse the code and obtain comment after assignment.
• pydoctor.tokenutils.comment_re
  pydoctor.tokenutils.html#comment_re
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.indent_re
  pydoctor.tokenutils.html#indent_re
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.tokenutils.extract_doc_comment_after
  pydoctor.tokenutils.html#extract_doc_comment_after
  Function
  Function
  PUBLIC
  Support for doc comment as found in sphinx.
• pydoctor.tokenutils.extract_doc_comment_before
  pydoctor.tokenutils.html#extract_doc_comment_before
  Function
  Function
  PUBLIC
  Same as extract_doc_comment_after but fetch the comment before the assignment.
• pydoctor.astbuilder.parseFile
  pydoctor.astbuilder.html#parseFile
  Function
  Function
  PUBLIC
  Parse the contents of a Python source file.
• pydoctor.astbuilder._parse
  pydoctor.astbuilder.html#_parse
  Function
  Function
  PRIVATE
  Wraps ast.parse.
• pydoctor.astbuilder._maybeAttribute
  pydoctor.astbuilder.html#_maybeAttribute
  Function
  Function
  PRIVATE
  Check whether a name is a potential attribute of the given class. This is used to prevent an assignment that wraps a method from creating an attribute that would overwrite or shadow that method.
• pydoctor.astbuilder.IgnoreAssignment
  pydoctor.astbuilder.IgnoreAssignment.html
  Class
  Exception
  PUBLIC
  A control flow exception meaning that the assignment should not be further proccessed.
• pydoctor.astbuilder._handleAliasing
  pydoctor.astbuilder.html#_handleAliasing
  Function
  Function
  PRIVATE
  If the given expression is a name assigned to a target that is not yet in use, create an alias.
• pydoctor.astbuilder._CONTROL_FLOW_BLOCKS
  pydoctor.astbuilder.html#_CONTROL_FLOW_BLOCKS
  Attribute
  Variable
  PRIVATE
  AST types that introduces a new control flow block, potentially conditionnal.
• pydoctor.astbuilder.is_constant
  pydoctor.astbuilder.html#is_constant
  Function
  Function
  PUBLIC
  Detect if the given assignment is a constant.
• pydoctor.astbuilder.TypeAliasVisitorExt
  pydoctor.astbuilder.TypeAliasVisitorExt.html
  Class
  Class
  PUBLIC
  This visitor implements the handling of type aliases and type variables.
• pydoctor.astbuilder.TypeAliasVisitorExt._isTypeVariable
  pydoctor.astbuilder.TypeAliasVisitorExt.html#_isTypeVariable
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.TypeAliasVisitorExt._isTypeAlias
  pydoctor.astbuilder.TypeAliasVisitorExt.html#_isTypeAlias
  Function
  Method
  PRIVATE
  Return True if the Attribute is a type alias.
• pydoctor.astbuilder.TypeAliasVisitorExt.visit_Assign
  pydoctor.astbuilder.TypeAliasVisitorExt.html#visit_Assign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.is_attribute_overridden
  pydoctor.astbuilder.html#is_attribute_overridden
  Function
  Function
  PUBLIC
  Detect if the optional new_value expression override the one already stored in the Attribute.value attribute.
• pydoctor.astbuilder.extract_final_subscript
  pydoctor.astbuilder.html#extract_final_subscript
  Function
  Function
  PUBLIC
  Extract the "str" part from annotations like "Final[str]".
• pydoctor.astbuilder.ModuleVistor
  pydoctor.astbuilder.ModuleVistor.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 instance variable, 12/42 methods, 0/3 static method, 0/1 class method documented
• pydoctor.astbuilder.ModuleVistor.__init__
  pydoctor.astbuilder.ModuleVistor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.builder
  pydoctor.astbuilder.ModuleVistor.html#builder
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.system
  pydoctor.astbuilder.ModuleVistor.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.module
  pydoctor.astbuilder.ModuleVistor.html#module
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor._override_guard_state
  pydoctor.astbuilder.ModuleVistor.html#_override_guard_state
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor.override_guard
  pydoctor.astbuilder.ModuleVistor.html#override_guard
  Function
  Method
  PUBLIC
  Returns a context manager that will make the builder ignore any new assigments to existing names within the same context. Currently used to visit If.orelse and Try.handlers.
• pydoctor.astbuilder.ModuleVistor._ignore_name
  pydoctor.astbuilder.ModuleVistor.html#_ignore_name
  Function
  Method
  PRIVATE
  Should this name be ignored because it matches the override guard in the context of ob?
• pydoctor.astbuilder.ModuleVistor._infer_attr_annotations
  pydoctor.astbuilder.ModuleVistor.html#_infer_attr_annotations
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._tweak_constants_annotations
  pydoctor.astbuilder.ModuleVistor.html#_tweak_constants_annotations
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_If
  pydoctor.astbuilder.ModuleVistor.html#visit_If
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.depart_If
  pydoctor.astbuilder.ModuleVistor.html#depart_If
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.depart_Try
  pydoctor.astbuilder.ModuleVistor.html#depart_Try
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_Module
  pydoctor.astbuilder.ModuleVistor.html#visit_Module
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.depart_Module
  pydoctor.astbuilder.ModuleVistor.html#depart_Module
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_ClassDef
  pydoctor.astbuilder.ModuleVistor.html#visit_ClassDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.depart_ClassDef
  pydoctor.astbuilder.ModuleVistor.html#depart_ClassDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_ImportFrom
  pydoctor.astbuilder.ModuleVistor.html#visit_ImportFrom
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor._importAll
  pydoctor.astbuilder.ModuleVistor.html#_importAll
  Function
  Method
  PRIVATE
  Handle a from <modname> import * statement.
• pydoctor.astbuilder.ModuleVistor._getCurrentModuleExports
  pydoctor.astbuilder.ModuleVistor.html#_getCurrentModuleExports
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleReExport
  pydoctor.astbuilder.ModuleVistor.html#_handleReExport
  Function
  Method
  PRIVATE
  Move re-exported objects into current module.
• pydoctor.astbuilder.ModuleVistor._importNames
  pydoctor.astbuilder.ModuleVistor.html#_importNames
  Function
  Method
  PRIVATE
  Handle a from <modname> import <names> statement.
• pydoctor.astbuilder.ModuleVistor.visit_Import
  pydoctor.astbuilder.ModuleVistor.html#visit_Import
  Function
  Method
  PUBLIC
  Process an import statement.
• pydoctor.astbuilder.ModuleVistor._handleOldSchoolMethodDecoration
  pydoctor.astbuilder.ModuleVistor.html#_handleOldSchoolMethodDecoration
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleConstant
  pydoctor.astbuilder.ModuleVistor.html#_handleConstant
  Function
  Class Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._tweak_constant_annotation
  pydoctor.astbuilder.ModuleVistor.html#_tweak_constant_annotation
  Function
  Static Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._setAttributeAnnotation
  pydoctor.astbuilder.ModuleVistor.html#_setAttributeAnnotation
  Function
  Static Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._storeAttrValue
  pydoctor.astbuilder.ModuleVistor.html#_storeAttrValue
  Function
  Static Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleModuleVar
  pydoctor.astbuilder.ModuleVistor.html#_handleModuleVar
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleAssignmentInModule
  pydoctor.astbuilder.ModuleVistor.html#_handleAssignmentInModule
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleClassVar
  pydoctor.astbuilder.ModuleVistor.html#_handleClassVar
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleInstanceVar
  pydoctor.astbuilder.ModuleVistor.html#_handleInstanceVar
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleAssignmentInClass
  pydoctor.astbuilder.ModuleVistor.html#_handleAssignmentInClass
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleDocstringUpdate
  pydoctor.astbuilder.ModuleVistor.html#_handleDocstringUpdate
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleAssignment
  pydoctor.astbuilder.ModuleVistor.html#_handleAssignment
  Function
  Method
  PRIVATE
  No summary
• pydoctor.astbuilder.ModuleVistor._handleAssignmentDoc
  pydoctor.astbuilder.ModuleVistor.html#_handleAssignmentDoc
  Function
  Method
  PRIVATE
  Process doc-comments and inline docstrings of the given assignment.
• pydoctor.astbuilder.ModuleVistor._handleDocComment
  pydoctor.astbuilder.ModuleVistor.html#_handleDocComment
  Function
  Method
  PRIVATE
  Process the doc-comments, this is very similar to the inline docstrings.
• pydoctor.astbuilder.ModuleVistor.visit_Assign
  pydoctor.astbuilder.ModuleVistor.html#visit_Assign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_AnnAssign
  pydoctor.astbuilder.ModuleVistor.html#visit_AnnAssign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor._getClassFromMethodContext
  pydoctor.astbuilder.ModuleVistor.html#_getClassFromMethodContext
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._contextualizeTarget
  pydoctor.astbuilder.ModuleVistor.html#_contextualizeTarget
  Function
  Method
  PRIVATE
  Find out the documentatble wich is the parent of the assignment's target as well as it's name.
• pydoctor.astbuilder.ModuleVistor._handleInlineDocstrings
  pydoctor.astbuilder.ModuleVistor.html#_handleInlineDocstrings
  Function
  Method
  PRIVATE
  Process the inline docstrings
• pydoctor.astbuilder.ModuleVistor.visit_AugAssign
  pydoctor.astbuilder.ModuleVistor.html#visit_AugAssign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_Expr
  pydoctor.astbuilder.ModuleVistor.html#visit_Expr
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_AsyncFunctionDef
  pydoctor.astbuilder.ModuleVistor.html#visit_AsyncFunctionDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.visit_FunctionDef
  pydoctor.astbuilder.ModuleVistor.html#visit_FunctionDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handleFunctionDef
  pydoctor.astbuilder.ModuleVistor.html#_handleFunctionDef
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor.depart_AsyncFunctionDef
  pydoctor.astbuilder.ModuleVistor.html#depart_AsyncFunctionDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor.depart_FunctionDef
  pydoctor.astbuilder.ModuleVistor.html#depart_FunctionDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ModuleVistor._handlePropertyDef
  pydoctor.astbuilder.ModuleVistor.html#_handlePropertyDef
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ModuleVistor._annotations_from_function
  pydoctor.astbuilder.ModuleVistor.html#_annotations_from_function
  Function
  Method
  PRIVATE
  Get annotations from a function definition.
• pydoctor.astbuilder.DocumentableT
  pydoctor.astbuilder.html#DocumentableT
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ASTBuilder
  pydoctor.astbuilder.ASTBuilder.html
  Class
  Class
  PUBLIC
  Keeps tracks of the state of the AST build, creates documentable and adds objects to the system.
• pydoctor.astbuilder.ASTBuilder.__init__
  pydoctor.astbuilder.ASTBuilder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ASTBuilder.system
  pydoctor.astbuilder.ASTBuilder.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astbuilder.ASTBuilder.current
  pydoctor.astbuilder.ASTBuilder.html#current
  Attribute
  Instance Variable
  PUBLIC
  current visited object
• pydoctor.astbuilder.ASTBuilder.currentMod
  pydoctor.astbuilder.ASTBuilder.html#currentMod
  Attribute
  Instance Variable
  PUBLIC
  module, set when visiting ast.Module
• pydoctor.astbuilder.ASTBuilder._stack
  pydoctor.astbuilder.ASTBuilder.html#_stack
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ASTBuilder._push
  pydoctor.astbuilder.ASTBuilder.html#_push
  Function
  Method
  PRIVATE
  Create and enter a new object of the given type and add it to the system.
• pydoctor.astbuilder.ASTBuilder._pop
  pydoctor.astbuilder.ASTBuilder.html#_pop
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.ASTBuilder.push
  pydoctor.astbuilder.ASTBuilder.html#push
  Function
  Method
  PUBLIC
  Enter a documentable.
• pydoctor.astbuilder.ASTBuilder.pop
  pydoctor.astbuilder.ASTBuilder.html#pop
  Function
  Method
  PUBLIC
  Leave a documentable.
• pydoctor.astbuilder.ASTBuilder.pushClass
  pydoctor.astbuilder.ASTBuilder.html#pushClass
  Function
  Method
  PUBLIC
  Create and a new class in the system.
• pydoctor.astbuilder.ASTBuilder.popClass
  pydoctor.astbuilder.ASTBuilder.html#popClass
  Function
  Method
  PUBLIC
  Leave a class.
• pydoctor.astbuilder.ASTBuilder.pushFunction
  pydoctor.astbuilder.ASTBuilder.html#pushFunction
  Function
  Method
  PUBLIC
  Create and enter a new function in the system.
• pydoctor.astbuilder.ASTBuilder.popFunction
  pydoctor.astbuilder.ASTBuilder.html#popFunction
  Function
  Method
  PUBLIC
  Leave a function.
• pydoctor.astbuilder.ASTBuilder.addAttribute
  pydoctor.astbuilder.ASTBuilder.html#addAttribute
  Function
  Method
  PUBLIC
  Add a new attribute to the system.
• pydoctor.astbuilder.ASTBuilder.processModuleAST
  pydoctor.astbuilder.ASTBuilder.html#processModuleAST
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.AstParseError
  pydoctor.astbuilder.AstParseError.html
  Class
  Class
  PUBLIC
  Parse errors are cached as instances of this class instead of bare exceptions in order to avoid cycles with the locals.
• pydoctor.astbuilder.AstParseError.__init__
  pydoctor.astbuilder.AstParseError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.AstParseError._exce
  pydoctor.astbuilder.AstParseError.html#_exce
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.astbuilder.AstParseError._args
  pydoctor.astbuilder.AstParseError.html#_args
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.astbuilder.AstParseError.exception
  pydoctor.astbuilder.AstParseError.html#exception
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser
  pydoctor.astbuilder.SyntaxTreeParser.html
  Class
  Class
  PUBLIC
  Responsible to read files and cache their parsed tree.
• pydoctor.astbuilder.SyntaxTreeParser.__init__
  pydoctor.astbuilder.SyntaxTreeParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser.ast_cache
  pydoctor.astbuilder.SyntaxTreeParser.html#ast_cache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser._parseFile
  pydoctor.astbuilder.SyntaxTreeParser.html#_parseFile
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser.parseFileOnly
  pydoctor.astbuilder.SyntaxTreeParser.html#parseFileOnly
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser.parseStringOnly
  pydoctor.astbuilder.SyntaxTreeParser.html#parseStringOnly
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser.parseFile
  pydoctor.astbuilder.SyntaxTreeParser.html#parseFile
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.SyntaxTreeParser.parseString
  pydoctor.astbuilder.SyntaxTreeParser.html#parseString
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.astbuilder.findModuleLevelAssign
  pydoctor.astbuilder.html#findModuleLevelAssign
  Function
  Function
  PUBLIC
  Find module level Assign. Yields tuples containing the assigment name and the Assign node.
• pydoctor.astbuilder.parseAll
  pydoctor.astbuilder.html#parseAll
  Function
  Function
  PUBLIC
  Find and attempt to parse into a list of names the __all__ variable of a module's AST and set Module.all accordingly.
• pydoctor.astbuilder.parseDocformat
  pydoctor.astbuilder.html#parseDocformat
  Function
  Function
  PUBLIC
  Find __docformat__ variable of this module's AST and set Module.docformat accordingly.
• pydoctor.astbuilder.MODULE_VARIABLES_META_PARSERS
  pydoctor.astbuilder.html#MODULE_VARIABLES_META_PARSERS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.astbuilder.setup_pydoctor_extension
  pydoctor.astbuilder.html#setup_pydoctor_extension
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.model.T
  pydoctor.model.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.model.LineFromAst
  pydoctor.model.LineFromAst.html
  Class
  Class
  PUBLIC
  Simple int wrapper for linenumbers coming from ast analysis.
• pydoctor.model.LineFromDocstringField
  pydoctor.model.LineFromDocstringField.html
  Class
  Class
  PUBLIC
  Simple int wrapper for linenumbers coming from docstrings.
• pydoctor.model.DocLocation
  pydoctor.model.DocLocation.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.DocLocation.OWN_PAGE
  pydoctor.model.DocLocation.html#OWN_PAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocLocation.PARENT_PAGE
  pydoctor.model.DocLocation.html#PARENT_PAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.ProcessingState
  pydoctor.model.ProcessingState.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.ProcessingState.UNPROCESSED
  pydoctor.model.ProcessingState.html#UNPROCESSED
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.ProcessingState.PROCESSING
  pydoctor.model.ProcessingState.html#PROCESSING
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.ProcessingState.PROCESSED
  pydoctor.model.ProcessingState.html#PROCESSED
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.PrivacyClass
  pydoctor.model.PrivacyClass.html
  Class
  Class
  PUBLIC
  Enum containing values indicating how private an object should be.
• pydoctor.model.PrivacyClass.HIDDEN
  pydoctor.model.PrivacyClass.html#HIDDEN
  Attribute
  Constant
  PUBLIC
  Don't show the object at all.
• pydoctor.model.PrivacyClass.PRIVATE
  pydoctor.model.PrivacyClass.html#PRIVATE
  Attribute
  Constant
  PUBLIC
  Show, but de-emphasize the object.
• pydoctor.model.PrivacyClass.PUBLIC
  pydoctor.model.PrivacyClass.html#PUBLIC
  Attribute
  Constant
  PUBLIC
  Show the object as normal.
• pydoctor.model.DocumentableKind
  pydoctor.model.DocumentableKind.html
  Class
  Class
  PUBLIC
  Enum containing values indicating the possible object types.
• pydoctor.model.DocumentableKind.NAMESPACE_PACKAGE
  pydoctor.model.DocumentableKind.html#NAMESPACE_PACKAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.PACKAGE
  pydoctor.model.DocumentableKind.html#PACKAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.MODULE
  pydoctor.model.DocumentableKind.html#MODULE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.CLASS
  pydoctor.model.DocumentableKind.html#CLASS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.INTERFACE
  pydoctor.model.DocumentableKind.html#INTERFACE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.EXCEPTION
  pydoctor.model.DocumentableKind.html#EXCEPTION
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.CLASS_METHOD
  pydoctor.model.DocumentableKind.html#CLASS_METHOD
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.STATIC_METHOD
  pydoctor.model.DocumentableKind.html#STATIC_METHOD
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.METHOD
  pydoctor.model.DocumentableKind.html#METHOD
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.FUNCTION
  pydoctor.model.DocumentableKind.html#FUNCTION
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.CONSTANT
  pydoctor.model.DocumentableKind.html#CONSTANT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.TYPE_VARIABLE
  pydoctor.model.DocumentableKind.html#TYPE_VARIABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.TYPE_ALIAS
  pydoctor.model.DocumentableKind.html#TYPE_ALIAS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.CLASS_VARIABLE
  pydoctor.model.DocumentableKind.html#CLASS_VARIABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.SCHEMA_FIELD
  pydoctor.model.DocumentableKind.html#SCHEMA_FIELD
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.ATTRIBUTE
  pydoctor.model.DocumentableKind.html#ATTRIBUTE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.INSTANCE_VARIABLE
  pydoctor.model.DocumentableKind.html#INSTANCE_VARIABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.PROPERTY
  pydoctor.model.DocumentableKind.html#PROPERTY
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.DocumentableKind.VARIABLE
  pydoctor.model.DocumentableKind.html#VARIABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.model.Documentable
  pydoctor.model.Documentable.html
  Class
  Class
  PUBLIC
  An object that can be documented.
• pydoctor.model.Documentable.docstring
  pydoctor.model.Documentable.html#docstring
  Attribute
  Instance Variable
  PUBLIC
  The object's docstring. But also see docsources.
• pydoctor.model.Documentable.system
  pydoctor.model.Documentable.html#system
  Attribute
  Instance Variable
  PUBLIC
  The system the object is part of.
• pydoctor.model.Documentable.parsed_docstring
  pydoctor.model.Documentable.html#parsed_docstring
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.parsed_summary
  pydoctor.model.Documentable.html#parsed_summary
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.parsed_type
  pydoctor.model.Documentable.html#parsed_type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.docstring_lineno
  pydoctor.model.Documentable.html#docstring_lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.linenumber
  pydoctor.model.Documentable.html#linenumber
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.source_href
  pydoctor.model.Documentable.html#source_href
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.kind
  pydoctor.model.Documentable.html#kind
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.__init__
  pydoctor.model.Documentable.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.name
  pydoctor.model.Documentable.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.parent
  pydoctor.model.Documentable.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.parentMod
  pydoctor.model.Documentable.html#parentMod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.source_path
  pydoctor.model.Documentable.html#source_path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.extra_info
  pydoctor.model.Documentable.html#extra_info
  Attribute
  Instance Variable
  PUBLIC
  A list to store extra informations about this documentable, as ParsedDocstring.
• pydoctor.model.Documentable.doctarget
  pydoctor.model.Documentable.html#doctarget
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.setup
  pydoctor.model.Documentable.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.contents
  pydoctor.model.Documentable.html#contents
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Documentable._linker
  pydoctor.model.Documentable.html#_linker
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.Documentable.setDocstring
  pydoctor.model.Documentable.html#setDocstring
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Documentable._setDocstringValue
  pydoctor.model.Documentable.html#_setDocstringValue
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Documentable.setLineNumber
  pydoctor.model.Documentable.html#setLineNumber
  Function
  Method
  PUBLIC
  Save the linenumber of this object.
• pydoctor.model.Documentable.description
  pydoctor.model.Documentable.html#description
  Attribute
  Property
  PUBLIC
  A string describing our source location to the user.
• pydoctor.model.Documentable.page_object
  pydoctor.model.Documentable.html#page_object
  Attribute
  Property
  PUBLIC
  The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc.
• pydoctor.model.Documentable.url
  pydoctor.model.Documentable.html#url
  Attribute
  Property
  PUBLIC
  Relative URL at which the documentation for this Documentable can be found.
• pydoctor.model.Documentable.fullName
  pydoctor.model.Documentable.html#fullName
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.__repr__
  pydoctor.model.Documentable.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Documentable.docsources
  pydoctor.model.Documentable.html#docsources
  Function
  Method
  PUBLIC
  Objects that can be considered as a source of documentation.
• pydoctor.model.Documentable.reparent
  pydoctor.model.Documentable.html#reparent
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Documentable._handle_reparenting_pre
  pydoctor.model.Documentable.html#_handle_reparenting_pre
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Documentable._handle_reparenting_post
  pydoctor.model.Documentable.html#_handle_reparenting_post
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Documentable._localNameToFullName
  pydoctor.model.Documentable.html#_localNameToFullName
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Documentable.isNameDefined
  pydoctor.model.Documentable.html#isNameDefined
  Function
  Method
  PUBLIC
  Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked.
• pydoctor.model.Documentable.expandName
  pydoctor.model.Documentable.html#expandName
  Function
  Method
  PUBLIC
  Return a fully qualified name for the possibly-dotted `name`.
• pydoctor.model.Documentable.expandAnnotationName
  pydoctor.model.Documentable.html#expandAnnotationName
  Function
  Method
  PUBLIC
  Like expandName but gives precedence to the module scope when a name is defined both in the current scope and the module scope.
• pydoctor.model.Documentable.resolveName
  pydoctor.model.Documentable.html#resolveName
  Function
  Method
  PUBLIC
  Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
• pydoctor.model.Documentable.privacyClass
  pydoctor.model.Documentable.html#privacyClass
  Attribute
  Property
  PUBLIC
  How visible this object should be.
• pydoctor.model.Documentable.isVisible
  pydoctor.model.Documentable.html#isVisible
  Attribute
  Property
  PUBLIC
  Is this object so private as to be not shown at all?
• pydoctor.model.Documentable.isPrivate
  pydoctor.model.Documentable.html#isPrivate
  Attribute
  Property
  PUBLIC
  Is this object considered private API?
• pydoctor.model.Documentable.module
  pydoctor.model.Documentable.html#module
  Attribute
  Property
  PUBLIC
  This object's Module.
• pydoctor.model.Documentable.report
  pydoctor.model.Documentable.html#report
  Function
  Method
  PUBLIC
  Log an error or warning about this documentable object.
• pydoctor.model.Documentable.docstring_linker
  pydoctor.model.Documentable.html#docstring_linker
  Attribute
  Property
  PUBLIC
  Returns an instance of DocstringLinker suitable for resolving names in the context of the object.
• pydoctor.model.CanContainImportsDocumentable
  pydoctor.model.CanContainImportsDocumentable.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.CanContainImportsDocumentable.setup
  pydoctor.model.CanContainImportsDocumentable.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.CanContainImportsDocumentable._localNameToFullName_map
  pydoctor.model.CanContainImportsDocumentable.html#_localNameToFullName_map
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.CanContainImportsDocumentable.isNameDefined
  pydoctor.model.CanContainImportsDocumentable.html#isNameDefined
  Function
  Method
  PUBLIC
  Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked.
• pydoctor.model.CanContainImportsDocumentable.localNames
  pydoctor.model.CanContainImportsDocumentable.html#localNames
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.ParsedAstModule
  pydoctor.model.ParsedAstModule.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.ParsedAstModule.root
  pydoctor.model.ParsedAstModule.html#root
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.ParsedAstModule.lines
  pydoctor.model.ParsedAstModule.html#lines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Module
  pydoctor.model.Module.html
  Class
  Class
  PUBLIC
  No class docstring; 1/3 property, 4/5 instance variables, 1/1 class variable, 1/4 method documented
• pydoctor.model.Module.parsed_ast
  pydoctor.model.Module.html#parsed_ast
  Attribute
  Class Variable
  PUBLIC
  When the AST of a module is succesfully parsed, it is encapsulated in a ParsedAstModule instance and stored here to be processed later.
• pydoctor.model.Module.privacyClass
  pydoctor.model.Module.html#privacyClass
  Attribute
  Property
  PUBLIC
  How visible this object should be.
• pydoctor.model.Module.setup
  pydoctor.model.Module.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Module._is_c_module
  pydoctor.model.Module.html#_is_c_module
  Attribute
  Instance Variable
  PRIVATE
  Whether this module is a C-extension.
• pydoctor.model.Module._py_mod
  pydoctor.model.Module.html#_py_mod
  Attribute
  Instance Variable
  PRIVATE
  The live module if the module was built from introspection.
• pydoctor.model.Module._py_string
  pydoctor.model.Module.html#_py_string
  Attribute
  Instance Variable
  PRIVATE
  The module string if the module was built from text.
• pydoctor.model.Module.all
  pydoctor.model.Module.html#all
  Attribute
  Instance Variable
  PUBLIC
  Names listed in the __all__ variable of this module.
• pydoctor.model.Module._docformat
  pydoctor.model.Module.html#_docformat
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.Module._localNameToFullName
  pydoctor.model.Module.html#_localNameToFullName
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Module.module
  pydoctor.model.Module.html#module
  Attribute
  Property
  PUBLIC
  This object's Module.
• pydoctor.model.Module.docformat
  pydoctor.model.Module.html#docformat
  Attribute
  Property
  PUBLIC
  The name of the format to be used for parsing docstrings in this module.
• pydoctor.model.Module.docformat.setter
  pydoctor.model.Module.html#docformat.setter
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Module.submodules
  pydoctor.model.Module.html#submodules
  Function
  Method
  PUBLIC
  Returns an iterator over the visible submodules.
• pydoctor.model.Package
  pydoctor.model.Package.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.Package.__repr__
  pydoctor.model.Package.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Package.setup
  pydoctor.model.Package.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Package.source_paths
  pydoctor.model.Package.html#source_paths
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Package.source_hrefs
  pydoctor.model.Package.html#source_hrefs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model._STD_LIB_EXCEPTIONS
  pydoctor.model.html#_STD_LIB_EXCEPTIONS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.model.is_exception
  pydoctor.model.html#is_exception
  Function
  Function
  PUBLIC
  Whether is class should be considered as an exception and be marked with the special kind DocumentableKind.EXCEPTION.
• pydoctor.model.topsort
  pydoctor.model.html#topsort
  Function
  Function
  PUBLIC
  Given a mapping where each key-value pair correspond to a node and it's predecessors, return the topological order of the nodes.
• pydoctor.model.ClassOrStr
  pydoctor.model.html#ClassOrStr
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• pydoctor.model.ClassHierarchyFinalizer
  pydoctor.model.ClassHierarchyFinalizer.html
  Class
  Class
  PUBLIC
  Encapsulate code related to class hierarchies post-processing.
• pydoctor.model.ClassHierarchyFinalizer._init_finalbaseobjects
  pydoctor.model.ClassHierarchyFinalizer.html#_init_finalbaseobjects
  Function
  Class Method
  PRIVATE
  The base objects are computed in two passes, first the ast visitor sets _initialbaseobjects, then we set _finalbaseobjects from this function which should be called during post-processing.
• pydoctor.model.ClassHierarchyFinalizer._getbases
  pydoctor.model.ClassHierarchyFinalizer.html#_getbases
  Function
  Static Method
  PRIVATE
  Like Class.baseobjects but fallback to the expanded name if the base is not resolved to a Class object.
• pydoctor.model.ClassHierarchyFinalizer.__init__
  pydoctor.model.ClassHierarchyFinalizer.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.model.ClassHierarchyFinalizer.graph
  pydoctor.model.ClassHierarchyFinalizer.html#graph
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.ClassHierarchyFinalizer.computed_mros
  pydoctor.model.ClassHierarchyFinalizer.html#computed_mros
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.ClassHierarchyFinalizer.compute_mros
  pydoctor.model.ClassHierarchyFinalizer.html#compute_mros
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.ClassHierarchyFinalizer._compute_mro
  pydoctor.model.ClassHierarchyFinalizer.html#_compute_mro
  Function
  Method
  PRIVATE
  Compute the method resolution order for this class. This assumes that the MRO of the bases of the class have already been computed and stored in self.computed_mros.
• pydoctor.model._find_dunder_constructor
  pydoctor.model.html#_find_dunder_constructor
  Function
  Function
  PRIVATE
  Find the a non-default python-powered dunder constructor. Returns None if neither __new__ or __init__ are defined.
• pydoctor.model.get_constructors
  pydoctor.model.html#get_constructors
  Function
  Function
  PUBLIC
  Look for python language powered constructors or classmethod constructors. A constructor MUST be a method accessible in the locals of the class.
• pydoctor.model.Class
  pydoctor.model.Class.html
  Class
  Class
  PUBLIC
  No class docstring; 4/4 properties, 0/6 instance variable, 0/4 class variable, 3/5 methods documented
• pydoctor.model.Class.parent
  pydoctor.model.Class.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Class.decorators
  pydoctor.model.Class.html#decorators
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Class._finalbaseobjects
  pydoctor.model.Class.html#_finalbaseobjects
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.model.Class._finalbases
  pydoctor.model.Class.html#_finalbases
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.model.Class._mro
  pydoctor.model.Class.html#_mro
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.model.Class.setup
  pydoctor.model.Class.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Class.rawbases
  pydoctor.model.Class.html#rawbases
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Class.raw_decorators
  pydoctor.model.Class.html#raw_decorators
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Class.subclasses
  pydoctor.model.Class.html#subclasses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Class._initialbases
  pydoctor.model.Class.html#_initialbases
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.Class._initialbaseobjects
  pydoctor.model.Class.html#_initialbaseobjects
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.Class.mro
  pydoctor.model.Class.html#mro
  Function
  Method
  PUBLIC
  Get the method resution order of this class.
• pydoctor.model.Class.bases
  pydoctor.model.Class.html#bases
  Attribute
  Property
  PUBLIC
  Fully qualified names of the bases of this class.
• pydoctor.model.Class.baseobjects
  pydoctor.model.Class.html#baseobjects
  Attribute
  Property
  PUBLIC
  Base objects, None value is inserted when the base class could not be found in the system.
• pydoctor.model.Class.public_constructors
  pydoctor.model.Class.html#public_constructors
  Attribute
  Property
  PUBLIC
  The public constructors of this class. A public constructor must not be hidden and have arguments or have a docstring.
• pydoctor.model.Class.allbases
  pydoctor.model.Class.html#allbases
  Function
  Method
  PUBLIC
  Iterate on all base objects of this class and it's super classes. Doesn't comply with MRO.
• pydoctor.model.Class.find
  pydoctor.model.Class.html#find
  Function
  Method
  PUBLIC
  Look up a name in this class and its base classes.
• pydoctor.model.Class._localNameToFullName
  pydoctor.model.Class.html#_localNameToFullName
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Class.constructor_params
  pydoctor.model.Class.html#constructor_params
  Attribute
  Property
  PUBLIC
  A mapping of constructor parameter names to their type annotation. If a parameter is not annotated, its value is None.
• pydoctor.model.Inheritable
  pydoctor.model.Inheritable.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.Inheritable.parent
  pydoctor.model.Inheritable.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Inheritable.docsources
  pydoctor.model.Inheritable.html#docsources
  Function
  Method
  PUBLIC
  Objects that can be considered as a source of documentation.
• pydoctor.model.Inheritable._localNameToFullName
  pydoctor.model.Inheritable.html#_localNameToFullName
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.Inheritable.isNameDefined
  pydoctor.model.Inheritable.html#isNameDefined
  Function
  Method
  PUBLIC
  Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked.
• pydoctor.model.Function
  pydoctor.model.Function.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.model.Function.is_async
  pydoctor.model.Function.html#is_async
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Function.annotations
  pydoctor.model.Function.html#annotations
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Function.decorators
  pydoctor.model.Function.html#decorators
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Function.signature
  pydoctor.model.Function.html#signature
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Function.overloads
  pydoctor.model.Function.html#overloads
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Function.parsed_signature
  pydoctor.model.Function.html#parsed_signature
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Function.setup
  pydoctor.model.Function.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.Function.kind
  pydoctor.model.Function.html#kind
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.FunctionOverload
  pydoctor.model.FunctionOverload.html
  Class
  Class
  PUBLIC
  No summary
• pydoctor.model.FunctionOverload.primary
  pydoctor.model.FunctionOverload.html#primary
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.FunctionOverload.signature
  pydoctor.model.FunctionOverload.html#signature
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.FunctionOverload.decorators
  pydoctor.model.FunctionOverload.html#decorators
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.FunctionOverload.parsed_signature
  pydoctor.model.FunctionOverload.html#parsed_signature
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.Attribute
  pydoctor.model.Attribute.html
  Class
  Class
  PUBLIC
  No class docstring; 1/3 class variable documented
• pydoctor.model.Attribute.annotation
  pydoctor.model.Attribute.html#annotation
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Attribute.decorators
  pydoctor.model.Attribute.html#decorators
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.Attribute.value
  pydoctor.model.Attribute.html#value
  Attribute
  Class Variable
  PUBLIC
  The value of the assignment expression.
• pydoctor.model.import_mod_from_file_location
  pydoctor.model.html#import_mod_from_file_location
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.model.func_types
  pydoctor.model.html#func_types
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.model._isfunction
  pydoctor.model.html#_isfunction
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.model._isdatadescriptor
  pydoctor.model.html#_isdatadescriptor
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.model._ignorable_dunders
  pydoctor.model.html#_ignorable_dunders
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.model._isignorable
  pydoctor.model.html#_isignorable
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.model.ModuleNotAdded
  pydoctor.model.ModuleNotAdded.html
  Class
  Exception
  PUBLIC
  Undocumented
• pydoctor.model._default_extensions
  pydoctor.model.html#_default_extensions
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.model.System
  pydoctor.model.System.html
  Class
  Class
  PUBLIC
  A collection of related documentable objects.
• pydoctor.model.System.systemBuilder
  pydoctor.model.System.html#systemBuilder
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.defaultBuilder
  pydoctor.model.System.html#defaultBuilder
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.syntaxTreeParser
  pydoctor.model.System.html#syntaxTreeParser
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.extensions
  pydoctor.model.System.html#extensions
  Attribute
  Instance Variable
  PUBLIC
  List of extensions.
• pydoctor.model.System.custom_extensions
  pydoctor.model.System.html#custom_extensions
  Attribute
  Class Variable
  PUBLIC
  Additional list of extensions to load alongside default extensions.
• pydoctor.model.System.show_attr_value
  pydoctor.model.System.html#show_attr_value
  Attribute
  Class Variable
  PUBLIC
  What kind of attributes we should display the value for?
• pydoctor.model.System.__init__
  pydoctor.model.System.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.allobjects
  pydoctor.model.System.html#allobjects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.rootobjects
  pydoctor.model.System.html#rootobjects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.violations
  pydoctor.model.System.html#violations
  Attribute
  Instance Variable
  PUBLIC
  The number of docstring problems found. This is used to determine whether to fail the build when using the --warnings-as-errors option, so it should only be increased for problems that the user can fix.
• pydoctor.model.System.options
  pydoctor.model.System.html#options
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.projectname
  pydoctor.model.System.html#projectname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.parse_errors
  pydoctor.model.System.html#parse_errors
  Attribute
  Instance Variable
  PUBLIC
  Dict from the name of the thing we're rendering (section) to the FullNames of objects for which the rendereable elements failed to parse. Typically the renderable element is the docstring, but it can be the decorators, parameter default values or any other colorized AST.
• pydoctor.model.System.verboselevel
  pydoctor.model.System.html#verboselevel
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.needsnl
  pydoctor.model.System.html#needsnl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.once_msgs
  pydoctor.model.System.html#once_msgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.unprocessed_modules
  pydoctor.model.System.html#unprocessed_modules
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.module_count
  pydoctor.model.System.html#module_count
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.processing_modules
  pydoctor.model.System.html#processing_modules
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.buildtime
  pydoctor.model.System.html#buildtime
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System.intersphinx
  pydoctor.model.System.html#intersphinx
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.System._ast_parser
  pydoctor.model.System.html#_ast_parser
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.System._privacyClassCache
  pydoctor.model.System.html#_privacyClassCache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.System._factory
  pydoctor.model.System.html#_factory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.System._astbuilder_visitors
  pydoctor.model.System.html#_astbuilder_visitors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.System._post_processor
  pydoctor.model.System.html#_post_processor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.System.Class
  pydoctor.model.System.html#Class
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.System.Function
  pydoctor.model.System.html#Function
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.System.Module
  pydoctor.model.System.html#Module
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.System.Package
  pydoctor.model.System.html#Package
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.System.Attribute
  pydoctor.model.System.html#Attribute
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.System.sourcebase
  pydoctor.model.System.html#sourcebase
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.model.System.root_names
  pydoctor.model.System.html#root_names
  Attribute
  Property
  PUBLIC
  The top-level package/module names in this system.
• pydoctor.model.System.progress
  pydoctor.model.System.html#progress
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.msg
  pydoctor.model.System.html#msg
  Function
  Method
  PUBLIC
  Log a message. pydoctor's logging system is bit messy.
• pydoctor.model.System.objForFullName
  pydoctor.model.System.html#objForFullName
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.find_object
  pydoctor.model.System.html#find_object
  Function
  Method
  PUBLIC
  Look up an object using a potentially outdated full name.
• pydoctor.model.System.objectsOfType
  pydoctor.model.System.html#objectsOfType
  Function
  Method
  PUBLIC
  Iterate over all instances of cls present in the system.
• pydoctor.model.System.privacyClass
  pydoctor.model.System.html#privacyClass
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.membersOrder
  pydoctor.model.System.html#membersOrder
  Function
  Method
  PUBLIC
  Returns a callable suitable to be used with sorted function. Used to sort the given object's members for presentation.
• pydoctor.model.System.addObject
  pydoctor.model.System.html#addObject
  Function
  Method
  PUBLIC
  Add object to the system.
• pydoctor.model.System._formatSourceHref
  pydoctor.model.System.html#_formatSourceHref
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.System.setSourceHref
  pydoctor.model.System.html#setSourceHref
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System._addPackageOrModule
  pydoctor.model.System.html#_addPackageOrModule
  Function
  Method
  PRIVATE
  Add a single package or module from path.
• pydoctor.model.System._addUnprocessedModule
  pydoctor.model.System.html#_addUnprocessedModule
  Function
  Method
  PRIVATE
  First add the new module into the unprocessed_modules list. Handle eventual duplication of module names, and finally add the module to the system.
• pydoctor.model.System._handleDuplicateModule
  pydoctor.model.System.html#_handleDuplicateModule
  Function
  Method
  PRIVATE
  This is called when two modules have the same name.
• pydoctor.model.System._introspectThing
  pydoctor.model.System.html#_introspectThing
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.System.introspectModule
  pydoctor.model.System.html#introspectModule
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.addPackage
  pydoctor.model.System.html#addPackage
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.addModule
  pydoctor.model.System.html#addModule
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System._is_pep420_namespace_package
  pydoctor.model.System.html#_is_pep420_namespace_package
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.System._is_oldschool_namespace_package
  pydoctor.model.System.html#_is_oldschool_namespace_package
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.System._remove
  pydoctor.model.System.html#_remove
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.model.System.handleDuplicate
  pydoctor.model.System.html#handleDuplicate
  Function
  Method
  PUBLIC
  This is called when we see two objects with the same .fullName(), for example:
• pydoctor.model.System.getProcessedModule
  pydoctor.model.System.html#getProcessedModule
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.processModule
  pydoctor.model.System.html#processModule
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.preProcess
  pydoctor.model.System.html#preProcess
  Function
  Method
  PUBLIC
  Called before any module gets processed, at this point the only existing objects are Modules.
• pydoctor.model.System.process
  pydoctor.model.System.html#process
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.model.System.postProcess
  pydoctor.model.System.html#postProcess
  Function
  Method
  PUBLIC
  Called when there are no more unprocessed modules.
• pydoctor.model.System.fetchIntersphinxInventories
  pydoctor.model.System.html#fetchIntersphinxInventories
  Function
  Method
  PUBLIC
  Download and parse intersphinx inventories based on configuration.
• pydoctor.model.defaultPostProcess
  pydoctor.model.html#defaultPostProcess
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.model._inherits_instance_variable_kind
  pydoctor.model.html#_inherits_instance_variable_kind
  Function
  Function
  PRIVATE
  If any of the inherited members of a class variable is an instance variable, then the subclass' class variable become an instance variable as well.
• pydoctor.model.get_docstring
  pydoctor.model.html#get_docstring
  Function
  Function
  PUBLIC
  Fetch the docstring for a documentable. Treat empty docstring as undocumented.
• pydoctor.model.SystemBuildingError
  pydoctor.model.SystemBuildingError.html
  Class
  Exception
  PUBLIC
  Raised when there is a (handled) fatal error while adding modules to the builder.
• pydoctor.model.ISystemBuilder
  pydoctor.model.ISystemBuilder.html
  Class
  Class
  PUBLIC
  Interface class for building a system.
• pydoctor.model.ISystemBuilder.__init__
  pydoctor.model.ISystemBuilder.html#__init__
  Function
  Method
  PUBLIC
  Create the builder.
• pydoctor.model.ISystemBuilder.addModule
  pydoctor.model.ISystemBuilder.html#addModule
  Function
  Method
  PUBLIC
  Add a module or package from file system path to the pydoctor system. If the path points to a directory, adds all submodules recursively.
• pydoctor.model.ISystemBuilder.addModuleString
  pydoctor.model.ISystemBuilder.html#addModuleString
  Function
  Method
  PUBLIC
  Add a module from text to the system.
• pydoctor.model.ISystemBuilder.buildModules
  pydoctor.model.ISystemBuilder.html#buildModules
  Function
  Method
  PUBLIC
  Build the modules.
• pydoctor.model.SystemBuilder
  pydoctor.model.SystemBuilder.html
  Class
  Class
  PUBLIC
  This class is only an adapter for some System methods related to module building.
• pydoctor.model.SystemBuilder.__init__
  pydoctor.model.SystemBuilder.html#__init__
  Function
  Method
  PUBLIC
  Create the builder.
• pydoctor.model.SystemBuilder.system
  pydoctor.model.SystemBuilder.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.model.SystemBuilder._added
  pydoctor.model.SystemBuilder.html#_added
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.model.SystemBuilder.addModule
  pydoctor.model.SystemBuilder.html#addModule
  Function
  Method
  PUBLIC
  Add a module or package from file system path to the pydoctor system. If the path points to a directory, adds all submodules recursively.
• pydoctor.model.SystemBuilder.addModuleString
  pydoctor.model.SystemBuilder.html#addModuleString
  Function
  Method
  PUBLIC
  Add a module from text to the system.
• pydoctor.model.SystemBuilder.buildModules
  pydoctor.model.SystemBuilder.html#buildModules
  Function
  Method
  PUBLIC
  Build the modules.
• pydoctor.model.prepend_package
  pydoctor.model.html#prepend_package
  Function
  Function
  PUBLIC
  Get a new system builder class, that extends the original builder such that it will always use a "fake" package to be the only root object of the system and add new modules under it.
• pydoctor.epydoc.markup.ObjClass
  pydoctor.epydoc.markup.html#ObjClass
  Attribute
  Type Alias
  PUBLIC
  A simpler version of DocumentableKind used for docstring parsing only.
• pydoctor.epydoc.markup.ParserFunction
  pydoctor.epydoc.markup.html#ParserFunction
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.get_supported_docformats
  pydoctor.epydoc.markup.html#get_supported_docformats
  Function
  Function
  PUBLIC
  Get the list of currently supported docformat.
• pydoctor.epydoc.markup.get_parser_by_name
  pydoctor.epydoc.markup.html#get_parser_by_name
  Function
  Function
  PUBLIC
  Get the parse_docstring(str, List[ParseError]) -> ParsedDocstring function based on a parser name.
• pydoctor.epydoc.markup.processtypes
  pydoctor.epydoc.markup.html#processtypes
  Function
  Function
  PUBLIC
  Wraps a docstring parser function to provide option --process-types.
• pydoctor.epydoc.markup.ParsedDocstring
  pydoctor.epydoc.markup.ParsedDocstring.html
  Class
  Class
  PUBLIC
  A standard intermediate representation for parsed docstrings that can be used to generate output. Parsed docstrings are produced by markup parsers such as pydoctor.epydoc.markup.epytext.parse_docstring()...
• pydoctor.epydoc.markup.ParsedDocstring.__init__
  pydoctor.epydoc.markup.ParsedDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.ParsedDocstring.fields
  pydoctor.epydoc.markup.ParsedDocstring.html#fields
  Attribute
  Instance Variable
  PUBLIC
  A list of Fields, each of which encodes a single field. The field's bodies are encoded as ParsedDocstrings.
• pydoctor.epydoc.markup.ParsedDocstring._stan
  pydoctor.epydoc.markup.ParsedDocstring.html#_stan
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.ParsedDocstring.has_body
  pydoctor.epydoc.markup.ParsedDocstring.html#has_body
  Attribute
  Property
  PUBLIC
  Does this docstring have a non-empty body?
• pydoctor.epydoc.markup.ParsedDocstring.get_toc
  pydoctor.epydoc.markup.ParsedDocstring.html#get_toc
  Function
  Method
  PUBLIC
  The table of contents of the docstring if titles are defined or None.
• pydoctor.epydoc.markup.ParsedDocstring.to_stan
  pydoctor.epydoc.markup.ParsedDocstring.html#to_stan
  Function
  Method
  PUBLIC
  Translate this docstring to a Stan tree.
• pydoctor.epydoc.markup.ParsedDocstring.to_node
  pydoctor.epydoc.markup.ParsedDocstring.html#to_node
  Function
  Method
  PUBLIC
  Translate this docstring to a nodes.document.
• pydoctor.epydoc.markup.ParsedDocstring.to_text
  pydoctor.epydoc.markup.ParsedDocstring.html#to_text
  Function
  Method
  PUBLIC
  Translate this docstring to a string. The default implementation depends on to_node.
• pydoctor.epydoc.markup.ParsedDocstring.get_summary
  pydoctor.epydoc.markup.ParsedDocstring.html#get_summary
  Function
  Method
  PUBLIC
  Returns the summary of this docstring.
• pydoctor.epydoc.markup.parsed_text
  pydoctor.epydoc.markup.html#parsed_text
  Function
  Function
  PUBLIC
  Create a parsed representation of a simple text with a given class (or no class at all).
• pydoctor.epydoc.markup.Field
  pydoctor.epydoc.markup.Field.html
  Class
  Class
  PUBLIC
  The contents of a docstring's field. Docstring fields are used to describe specific aspects of an object, such as a parameter of a function or the author of a module. Each field consists of a tag, an optional argument, and a body:...
• pydoctor.epydoc.markup.Field.__init__
  pydoctor.epydoc.markup.Field.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.Field._tag
  pydoctor.epydoc.markup.Field.html#_tag
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.Field._arg
  pydoctor.epydoc.markup.Field.html#_arg
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.Field._body
  pydoctor.epydoc.markup.Field.html#_body
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.Field.lineno
  pydoctor.epydoc.markup.Field.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.Field.tag
  pydoctor.epydoc.markup.Field.html#tag
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.Field.arg
  pydoctor.epydoc.markup.Field.html#arg
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.Field.body
  pydoctor.epydoc.markup.Field.html#body
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.Field.replace_body
  pydoctor.epydoc.markup.Field.html#replace_body
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.Field.__repr__
  pydoctor.epydoc.markup.Field.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.DocstringLinker
  pydoctor.epydoc.markup.DocstringLinker.html
  Class
  Class
  PUBLIC
  A resolver for crossreference links out of a ParsedDocstring. DocstringLinker is used by ParsedDocstring to look up the target URL for crossreference links.
• pydoctor.epydoc.markup.DocstringLinker.link_to
  pydoctor.epydoc.markup.DocstringLinker.html#link_to
  Function
  Method
  PUBLIC
  Format a link to a Python identifier. This will resolve the identifier like Python itself would.
• pydoctor.epydoc.markup.DocstringLinker.link_xref
  pydoctor.epydoc.markup.DocstringLinker.html#link_xref
  Function
  Method
  PUBLIC
  Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
• pydoctor.epydoc.markup.DocstringLinker.switch_context
  pydoctor.epydoc.markup.DocstringLinker.html#switch_context
  Function
  Method
  PUBLIC
  Switch the context of the linker, keeping the same underlying lookup rules.
• pydoctor.epydoc.markup.append_warnings
  pydoctor.epydoc.markup.html#append_warnings
  Function
  Function
  PUBLIC
  Utility method to create non fatal ParseErrors and append them to the provided list.
• pydoctor.epydoc.markup.ParseError
  pydoctor.epydoc.markup.ParseError.html
  Class
  Exception
  PUBLIC
  The base class for errors generated while parsing docstrings.
• pydoctor.epydoc.markup.ParseError.__init__
  pydoctor.epydoc.markup.ParseError.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.ParseError._descr
  pydoctor.epydoc.markup.ParseError.html#_descr
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.ParseError._linenum
  pydoctor.epydoc.markup.ParseError.html#_linenum
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.ParseError._fatal
  pydoctor.epydoc.markup.ParseError.html#_fatal
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.ParseError.is_fatal
  pydoctor.epydoc.markup.ParseError.html#is_fatal
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.ParseError.linenum
  pydoctor.epydoc.markup.ParseError.html#linenum
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.ParseError.descr
  pydoctor.epydoc.markup.ParseError.html#descr
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.ParseError.__str__
  pydoctor.epydoc.markup.ParseError.html#__str__
  Function
  Method
  PUBLIC
  Return a string representation of this ParseError. This multi-line string contains a description of the error, and specifies where it occured.
• pydoctor.epydoc.markup.ParseError.__repr__
  pydoctor.epydoc.markup.ParseError.html#__repr__
  Function
  Method
  PUBLIC
  Return the formal representation of this ParseError. ParseErrors have formal representations of the form:
• pydoctor.epydoc.markup.SummaryExtractor
  pydoctor.epydoc.markup.SummaryExtractor.html
  Class
  Class
  PUBLIC
  A docutils node visitor that extracts first sentences from the first paragraph in a document.
• pydoctor.epydoc.markup.SummaryExtractor.__init__
  pydoctor.epydoc.markup.SummaryExtractor.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.SummaryExtractor.summary
  pydoctor.epydoc.markup.SummaryExtractor.html#summary
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor.other_docs
  pydoctor.epydoc.markup.SummaryExtractor.html#other_docs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor.maxchars
  pydoctor.epydoc.markup.SummaryExtractor.html#maxchars
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor.visit_document
  pydoctor.epydoc.markup.SummaryExtractor.html#visit_document
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor._SENTENCE_RE_SPLIT
  pydoctor.epydoc.markup.SummaryExtractor.html#_SENTENCE_RE_SPLIT
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor.visit_paragraph
  pydoctor.epydoc.markup.SummaryExtractor.html#visit_paragraph
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor.visit_field
  pydoctor.epydoc.markup.SummaryExtractor.html#visit_field
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.SummaryExtractor.unknown_visit
  pydoctor.epydoc.markup.SummaryExtractor.html#unknown_visit
  Function
  Method
  PUBLIC
  Ignore all unknown nodes
• pydoctor._configparser.toml_load
  pydoctor._configparser.html#toml_load
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor._configparser._QUOTED_STR_REGEX
  pydoctor._configparser.html#_QUOTED_STR_REGEX
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor._configparser._TRIPLE_QUOTED_STR_REGEX
  pydoctor._configparser.html#_TRIPLE_QUOTED_STR_REGEX
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor._configparser.is_quoted
  pydoctor._configparser.html#is_quoted
  Function
  Function
  PUBLIC
  Detect whether a string is a quoted representation.
• pydoctor._configparser.unquote_str
  pydoctor._configparser.html#unquote_str
  Function
  Function
  PUBLIC
  Unquote a maybe quoted string representation. If the string is not detected as being a quoted representation, it returns the same string as passed. It supports all kinds of python quotes: """, ''', " and ...
• pydoctor._configparser.parse_toml_section_name
  pydoctor._configparser.html#parse_toml_section_name
  Function
  Function
  PUBLIC
  Parse a TOML section name to a sequence of strings.
• pydoctor._configparser.get_toml_section
  pydoctor._configparser.html#get_toml_section
  Function
  Function
  PUBLIC
  Given some TOML data (as loaded with toml.load()), returns the requested section of the data. Returns None if the section is not found.
• pydoctor._configparser.TomlConfigParser
  pydoctor._configparser.TomlConfigParser.html
  Class
  Class
  PUBLIC
  TOML parser with support for sections.
• pydoctor._configparser.TomlConfigParser.__init__
  pydoctor._configparser.TomlConfigParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.TomlConfigParser.sections
  pydoctor._configparser.TomlConfigParser.html#sections
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor._configparser.TomlConfigParser.__call__
  pydoctor._configparser.TomlConfigParser.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.TomlConfigParser.parse
  pydoctor._configparser.TomlConfigParser.html#parse
  Function
  Method
  PUBLIC
  Parses the keys and values from a TOML config file.
• pydoctor._configparser.TomlConfigParser.get_syntax_description
  pydoctor._configparser.TomlConfigParser.html#get_syntax_description
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.IniConfigParser
  pydoctor._configparser.IniConfigParser.html
  Class
  Class
  PUBLIC
  INI parser with support for sections.
• pydoctor._configparser.IniConfigParser.__init__
  pydoctor._configparser.IniConfigParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.IniConfigParser.sections
  pydoctor._configparser.IniConfigParser.html#sections
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor._configparser.IniConfigParser.split_ml_text_to_list
  pydoctor._configparser.IniConfigParser.html#split_ml_text_to_list
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor._configparser.IniConfigParser.__call__
  pydoctor._configparser.IniConfigParser.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.IniConfigParser.parse
  pydoctor._configparser.IniConfigParser.html#parse
  Function
  Method
  PUBLIC
  Parses the keys and values from an INI config file.
• pydoctor._configparser.IniConfigParser.get_syntax_description
  pydoctor._configparser.IniConfigParser.html#get_syntax_description
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.CompositeConfigParser
  pydoctor._configparser.CompositeConfigParser.html
  Class
  Class
  PUBLIC
  A config parser that understands multiple formats.
• pydoctor._configparser.CompositeConfigParser.__init__
  pydoctor._configparser.CompositeConfigParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.CompositeConfigParser.parsers
  pydoctor._configparser.CompositeConfigParser.html#parsers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor._configparser.CompositeConfigParser.__call__
  pydoctor._configparser.CompositeConfigParser.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.CompositeConfigParser.parse
  pydoctor._configparser.CompositeConfigParser.html#parse
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.CompositeConfigParser.get_syntax_description
  pydoctor._configparser.CompositeConfigParser.html#get_syntax_description
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.ValidatorParser
  pydoctor._configparser.ValidatorParser.html
  Class
  Class
  PUBLIC
  A parser that warns when unknown options are used. It must be created with a reference to the ArgumentParser object, so like:
• pydoctor._configparser.ValidatorParser.__init__
  pydoctor._configparser.ValidatorParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.ValidatorParser.config_parser
  pydoctor._configparser.ValidatorParser.html#config_parser
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor._configparser.ValidatorParser.argument_parser
  pydoctor._configparser.ValidatorParser.html#argument_parser
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor._configparser.ValidatorParser.get_syntax_description
  pydoctor._configparser.ValidatorParser.html#get_syntax_description
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor._configparser.ValidatorParser.parse
  pydoctor._configparser.ValidatorParser.html#parse
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.DocGetter
  pydoctor.templatewriter.util.DocGetter.html
  Class
  Class
  PUBLIC
  epydoc2stan bridge.
• pydoctor.templatewriter.util.DocGetter.get
  pydoctor.templatewriter.util.DocGetter.html#get
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.DocGetter.get_type
  pydoctor.templatewriter.util.DocGetter.html#get_type
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.DocGetter.get_toc
  pydoctor.templatewriter.util.DocGetter.html#get_toc
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.srclink
  pydoctor.templatewriter.util.html#srclink
  Function
  Function
  PUBLIC
  Get object source code URL, i.e. hosted on github.
• pydoctor.templatewriter.util.package_srclinks
  pydoctor.templatewriter.util.html#package_srclinks
  Function
  Function
  PUBLIC
  Get (namespace) package source code URLs, i.e. hosted on github.
• pydoctor.templatewriter.util.css_class
  pydoctor.templatewriter.util.html#css_class
  Function
  Function
  PUBLIC
  A short, lower case description for use as a CSS class in HTML. Includes the kind and privacy.
• pydoctor.templatewriter.util.overriding_subclasses
  pydoctor.templatewriter.util.html#overriding_subclasses
  Function
  Function
  PUBLIC
  Helper function to retreive the subclasses that override the given name from the parent class object.
• pydoctor.templatewriter.util.nested_bases
  pydoctor.templatewriter.util.html#nested_bases
  Function
  Function
  PUBLIC
  Helper function to retreive the complete list of base classes chains (represented by tuples) for a given Class. A chain of classes is used to compute the member inheritence from the first element to the last element of the chain.
• pydoctor.templatewriter.util.unmasked_attrs
  pydoctor.templatewriter.util.html#unmasked_attrs
  Function
  Function
  PUBLIC
  Helper function to reteive the list of inherited children given a base classes chain (As yielded by nested_bases). The returned members are inherited from the Class listed first in the chain to the Class listed last: they are not overriden in between.
• pydoctor.templatewriter.util.alphabetical_order_func
  pydoctor.templatewriter.util.html#alphabetical_order_func
  Function
  Function
  PUBLIC
  Sort by privacy, kind and fullname. Callable to use as the value of standard library's sorted function key argument.
• pydoctor.templatewriter.util.source_order_func
  pydoctor.templatewriter.util.html#source_order_func
  Function
  Function
  PUBLIC
  Sort by privacy, kind and linenumber. Callable to use as the value of standard library's sorted function key argument.
• pydoctor.templatewriter.util._map_kind
  pydoctor.templatewriter.util.html#_map_kind
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.templatewriter.util.objects_order
  pydoctor.templatewriter.util.html#objects_order
  Function
  Function
  PUBLIC
  Function to craft a callable to use as the value of standard library's sorted function key argument such that the objects are sorted by: Privacy, Kind first, then by Name or Linenumber depending on order...
• pydoctor.templatewriter.util.class_members
  pydoctor.templatewriter.util.html#class_members
  Function
  Function
  PUBLIC
  Returns the members as well as the inherited members of a class.
• pydoctor.templatewriter.util.inherited_members
  pydoctor.templatewriter.util.html#inherited_members
  Function
  Function
  PUBLIC
  Returns only the inherited members of a class, as a plain list.
• pydoctor.templatewriter.util.templatefile
  pydoctor.templatewriter.util.html#templatefile
  Function
  Function
  PUBLIC
  Deprecated: can be removed once Twisted stops patching this.
• pydoctor.templatewriter.util._VT
  pydoctor.templatewriter.util.html#_VT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict
  pydoctor.templatewriter.util.CaseInsensitiveDict.html
  Class
  Class
  PUBLIC
  A case-insensitive ``dict``-like object. Implements all methods and operations of ``collections.MutableMapping`` as well as dict's ``copy``. Also provides ``lower_items``. All keys are expected to be strings...
• pydoctor.templatewriter.util.CaseInsensitiveDict.__init__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict._store
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#_store
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.__setitem__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.__getitem__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.__delitem__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__delitem__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.__iter__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.__len__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.lower_items
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#lower_items
  Function
  Method
  PUBLIC
  Like iteritems(), but with all lowercase keys.
• pydoctor.templatewriter.util.CaseInsensitiveDict.__eq__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.copy
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#copy
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.util.CaseInsensitiveDict.__repr__
  pydoctor.templatewriter.util.CaseInsensitiveDict.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.DOCTYPE
  pydoctor.templatewriter.html#DOCTYPE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.templatewriter.parse_xml
  pydoctor.templatewriter.html#parse_xml
  Function
  Function
  PUBLIC
  Create a minidom representaton of the XML string.
• pydoctor.templatewriter.TemplateError
  pydoctor.templatewriter.TemplateError.html
  Class
  Exception
  PUBLIC
  Raised when there is an problem with a template. TemplateErrors are fatal.
• pydoctor.templatewriter.UnsupportedTemplateVersion
  pydoctor.templatewriter.UnsupportedTemplateVersion.html
  Class
  Exception
  PUBLIC
  Raised when custom template is designed for a newer version of pydoctor
• pydoctor.templatewriter.OverrideTemplateNotAllowed
  pydoctor.templatewriter.OverrideTemplateNotAllowed.html
  Class
  Exception
  PUBLIC
  Raised when a template path overrides a path of a different type (HTML/static/directory).
• pydoctor.templatewriter.FailedToCreateTemplate
  pydoctor.templatewriter.FailedToCreateTemplate.html
  Class
  Exception
  PUBLIC
  Raised when a template could not be created because of an error
• pydoctor.templatewriter.IWriter
  pydoctor.templatewriter.IWriter.html
  Class
  Class
  PUBLIC
  Interface class for pydoctor output writer.
• pydoctor.templatewriter.IWriter.__init__
  pydoctor.templatewriter.IWriter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.IWriter.prepOutputDirectory
  pydoctor.templatewriter.IWriter.html#prepOutputDirectory
  Function
  Method
  PUBLIC
  Called first.
• pydoctor.templatewriter.IWriter.writeSummaryPages
  pydoctor.templatewriter.IWriter.html#writeSummaryPages
  Function
  Method
  PUBLIC
  Called second.
• pydoctor.templatewriter.IWriter.writeIndividualFiles
  pydoctor.templatewriter.IWriter.html#writeIndividualFiles
  Function
  Method
  PUBLIC
  Called third.
• pydoctor.templatewriter.IWriter.writeLinks
  pydoctor.templatewriter.IWriter.html#writeLinks
  Function
  Method
  PUBLIC
  Called after writeIndividualFiles when option --html-subject is not used.
• pydoctor.templatewriter.Template
  pydoctor.templatewriter.Template.html
  Class
  Class
  PUBLIC
  Represents a pydoctor template file.
• pydoctor.templatewriter.Template.__init__
  pydoctor.templatewriter.Template.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.Template.name
  pydoctor.templatewriter.Template.html#name
  Attribute
  Instance Variable
  PUBLIC
  Template filename, may include subdirectories.
• pydoctor.templatewriter.Template.fromdir
  pydoctor.templatewriter.Template.html#fromdir
  Function
  Class Method
  PUBLIC
  Scan a directory for templates.
• pydoctor.templatewriter.Template.fromfile
  pydoctor.templatewriter.Template.html#fromfile
  Function
  Class Method
  PUBLIC
  Create a concrete template object. Type depends on the file extension.
• pydoctor.templatewriter.StaticTemplate
  pydoctor.templatewriter.StaticTemplate.html
  Class
  Class
  PUBLIC
  Static template: no rendering, will be copied as is to build directory.
• pydoctor.templatewriter.StaticTemplate.__init__
  pydoctor.templatewriter.StaticTemplate.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.StaticTemplate.data
  pydoctor.templatewriter.StaticTemplate.html#data
  Attribute
  Instance Variable
  PUBLIC
  Contents of the template file as bytes.
• pydoctor.templatewriter.StaticTemplate.write
  pydoctor.templatewriter.StaticTemplate.html#write
  Function
  Method
  PUBLIC
  Directly write the contents of this static template as is to the build dir.
• pydoctor.templatewriter.HtmlTemplate
  pydoctor.templatewriter.HtmlTemplate.html
  Class
  Class
  PUBLIC
  HTML template that works with the Twisted templating system and use xml.dom.minidom to parse the pydoctor-template-version meta tag.
• pydoctor.templatewriter.HtmlTemplate.text
  pydoctor.templatewriter.HtmlTemplate.html#text
  Attribute
  Instance Variable
  PUBLIC
  Contents of the template file as UFT-8 decoded str.
• pydoctor.templatewriter.HtmlTemplate.version
  pydoctor.templatewriter.HtmlTemplate.html#version
  Attribute
  Instance Variable
  PUBLIC
  Template version, -1 if no version could be read in the XML file.
• pydoctor.templatewriter.HtmlTemplate.loader
  pydoctor.templatewriter.HtmlTemplate.html#loader
  Attribute
  Instance Variable
  PUBLIC
  Object used to render the final HTML file with the Twisted templating system.
• pydoctor.templatewriter.HtmlTemplate.__init__
  pydoctor.templatewriter.HtmlTemplate.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.HtmlTemplate._dom
  pydoctor.templatewriter.HtmlTemplate.html#_dom
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.HtmlTemplate._extract_version
  pydoctor.templatewriter.HtmlTemplate.html#_extract_version
  Function
  Static Method
  PRIVATE
  Undocumented
• pydoctor.templatewriter.TemplateLookup
  pydoctor.templatewriter.TemplateLookup.html
  Class
  Class
  PUBLIC
  The TemplateLookup handles the HTML template files locations. A little bit like mako.lookup.TemplateLookup but more simple.
• pydoctor.templatewriter.TemplateLookup.__init__
  pydoctor.templatewriter.TemplateLookup.html#__init__
  Function
  Method
  PUBLIC
  Loads all templates from the given path into the lookup.
• pydoctor.templatewriter.TemplateLookup._templates
  pydoctor.templatewriter.TemplateLookup.html#_templates
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.TemplateLookup._add_overriding_html_template
  pydoctor.templatewriter.TemplateLookup.html#_add_overriding_html_template
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.templatewriter.TemplateLookup._raise_if_overrides_directory
  pydoctor.templatewriter.TemplateLookup.html#_raise_if_overrides_directory
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.templatewriter.TemplateLookup.add_template
  pydoctor.templatewriter.TemplateLookup.html#add_template
  Function
  Method
  PUBLIC
  Add a template to the lookup. The custom template override the default.
• pydoctor.templatewriter.TemplateLookup.add_templatedir
  pydoctor.templatewriter.TemplateLookup.html#add_templatedir
  Function
  Method
  PUBLIC
  Scan a directory and add all templates in the given directory to the lookup.
• pydoctor.templatewriter.TemplateLookup.get_template
  pydoctor.templatewriter.TemplateLookup.html#get_template
  Function
  Method
  PUBLIC
  Lookup a template based on its filename.
• pydoctor.templatewriter.TemplateLookup.get_loader
  pydoctor.templatewriter.TemplateLookup.html#get_loader
  Function
  Method
  PUBLIC
  Lookup a HTML template loader based on its filename.
• pydoctor.templatewriter.TemplateLookup.templates
  pydoctor.templatewriter.TemplateLookup.html#templates
  Attribute
  Property
  PUBLIC
  All templates that can be looked up. For each name, the custom template will be included if it exists, otherwise the default template.
• pydoctor.templatewriter.TemplateElement
  pydoctor.templatewriter.TemplateElement.html
  Class
  Class
  PUBLIC
  Renderable element based on a template file.
• pydoctor.templatewriter.TemplateElement.lookup_loader
  pydoctor.templatewriter.TemplateElement.html#lookup_loader
  Function
  Class Method
  PUBLIC
  Lookup the element ITemplateLoader with the TemplateLookup.
• pydoctor.extensions.zopeinterface.ZopeInterfaceModule
  pydoctor.extensions.zopeinterface.ZopeInterfaceModule.html
  Class
  Class
  PUBLIC
  No class docstring; 1/1 property, 0/1 instance variable, 0/1 method documented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModule.setup
  pydoctor.extensions.zopeinterface.ZopeInterfaceModule.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModule.implements_directly
  pydoctor.extensions.zopeinterface.ZopeInterfaceModule.html#implements_directly
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModule.allImplementedInterfaces
  pydoctor.extensions.zopeinterface.ZopeInterfaceModule.html#allImplementedInterfaces
  Attribute
  Property
  PUBLIC
  Return all the interfaces provided by this module
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html
  Class
  Class
  PUBLIC
  No class docstring; 1/1 property, 0/2 instance variable, 1/6 class variable, 0/1 method documented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.isinterface
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#isinterface
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.isschemafield
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#isschemafield
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.isinterfaceclass
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#isinterfaceclass
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.implementsOnly
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#implementsOnly
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.implementedby_directly
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#implementedby_directly
  Attribute
  Class Variable
  PUBLIC
  Only defined when isinterface == True.
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.baseobjects
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#baseobjects
  Attribute
  Class Variable
  PUBLIC
  Base objects, None value is inserted when the base class could not be found in the system.
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.subclasses
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#subclasses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.setup
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.implements_directly
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#implements_directly
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceClass.allImplementedInterfaces
  pydoctor.extensions.zopeinterface.ZopeInterfaceClass.html#allImplementedInterfaces
  Attribute
  Property
  PUBLIC
  Return all the interfaces implemented by this class.
• pydoctor.extensions.zopeinterface._inheritedDocsources
  pydoctor.extensions.zopeinterface.html#_inheritedDocsources
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceFunction
  pydoctor.extensions.zopeinterface.ZopeInterfaceFunction.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceFunction.docsources
  pydoctor.extensions.zopeinterface.ZopeInterfaceFunction.html#docsources
  Function
  Method
  PUBLIC
  Objects that can be considered as a source of documentation.
• pydoctor.extensions.zopeinterface.ZopeInterfaceAttribute
  pydoctor.extensions.zopeinterface.ZopeInterfaceAttribute.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceAttribute.docsources
  pydoctor.extensions.zopeinterface.ZopeInterfaceAttribute.html#docsources
  Function
  Method
  PUBLIC
  Objects that can be considered as a source of documentation.
• pydoctor.extensions.zopeinterface.addInterfaceInfoToScope
  pydoctor.extensions.zopeinterface.html#addInterfaceInfoToScope
  Function
  Function
  PUBLIC
  Mark the given class or module as implementing the given interfaces.
• pydoctor.extensions.zopeinterface._handle_implemented
  pydoctor.extensions.zopeinterface.html#_handle_implemented
  Function
  Function
  PRIVATE
  This is the counterpart to addInterfaceInfoToScope(), which is called during post-processing.
• pydoctor.extensions.zopeinterface.addInterfaceInfoToModule
  pydoctor.extensions.zopeinterface.html#addInterfaceInfoToModule
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.addInterfaceInfoToClass
  pydoctor.extensions.zopeinterface.html#addInterfaceInfoToClass
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.schema_prog
  pydoctor.extensions.zopeinterface.html#schema_prog
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.interface_prog
  pydoctor.extensions.zopeinterface.html#interface_prog
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.namesInterface
  pydoctor.extensions.zopeinterface.html#namesInterface
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor._handleZopeInterfaceAssignmentInModule
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#_handleZopeInterfaceAssignmentInModule
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor._handleZopeInterfaceAssignmentInClass
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#_handleZopeInterfaceAssignmentInClass
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor._handleZopeInterfaceAssignment
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#_handleZopeInterfaceAssignment
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.visit_Assign
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#visit_Assign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.visit_Call
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#visit_Call
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.visit_Call_zope_interface_moduleProvides
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#visit_Call_zope_interface_moduleProvides
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.visit_Call_zope_interface_implements
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#visit_Call_zope_interface_implements
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.visit_Call_zope_interface_classImplements
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#visit_Call_zope_interface_classImplements
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.depart_ClassDef
  pydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor.html#depart_ClassDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.postProcess
  pydoctor.extensions.zopeinterface.html#postProcess
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.extensions.zopeinterface.setup_pydoctor_extension
  pydoctor.extensions.zopeinterface.html#setup_pydoctor_extension
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow
  pydoctor.templatewriter.pages.table.TableRow.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.__init__
  pydoctor.templatewriter.pages.table.TableRow.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.docgetter
  pydoctor.templatewriter.pages.table.TableRow.html#docgetter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.ob
  pydoctor.templatewriter.pages.table.TableRow.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.child
  pydoctor.templatewriter.pages.table.TableRow.html#child
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.class_
  pydoctor.templatewriter.pages.table.TableRow.html#class_
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.kind
  pydoctor.templatewriter.pages.table.TableRow.html#kind
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.name
  pydoctor.templatewriter.pages.table.TableRow.html#name
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.TableRow.summaryDoc
  pydoctor.templatewriter.pages.table.TableRow.html#summaryDoc
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable
  pydoctor.templatewriter.pages.table.ChildTable.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.last_id
  pydoctor.templatewriter.pages.table.ChildTable.html#last_id
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.filename
  pydoctor.templatewriter.pages.table.ChildTable.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.__init__
  pydoctor.templatewriter.pages.table.ChildTable.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.children
  pydoctor.templatewriter.pages.table.ChildTable.html#children
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable._id
  pydoctor.templatewriter.pages.table.ChildTable.html#_id
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.ob
  pydoctor.templatewriter.pages.table.ChildTable.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.docgetter
  pydoctor.templatewriter.pages.table.ChildTable.html#docgetter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.id
  pydoctor.templatewriter.pages.table.ChildTable.html#id
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.table.ChildTable.rows
  pydoctor.templatewriter.pages.table.ChildTable.html#rows
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.iterators.T
  pydoctor.napoleon.iterators.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• pydoctor.napoleon.iterators.peek_iter
  pydoctor.napoleon.iterators.peek_iter.html
  Class
  Class
  PUBLIC
  An iterator object that supports peeking ahead.
• pydoctor.napoleon.iterators.peek_iter.sentinel
  pydoctor.napoleon.iterators.peek_iter.html#sentinel
  Attribute
  Instance Variable
  PUBLIC
  The value used to indicate the iterator is exhausted. If sentinel was not given when the peek_iter was instantiated, then it will be set to a new object instance: object().
• pydoctor.napoleon.iterators.peek_iter.counter
  pydoctor.napoleon.iterators.peek_iter.html#counter
  Attribute
  Instance Variable
  PUBLIC
  Store and increment line number to report correct lines!
• pydoctor.napoleon.iterators.peek_iter.__init__
  pydoctor.napoleon.iterators.peek_iter.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.napoleon.iterators.peek_iter._iterable
  pydoctor.napoleon.iterators.peek_iter.html#_iterable
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.iterators.peek_iter._cache
  pydoctor.napoleon.iterators.peek_iter.html#_cache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.iterators.peek_iter.__iter__
  pydoctor.napoleon.iterators.peek_iter.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.iterators.peek_iter.__next__
  pydoctor.napoleon.iterators.peek_iter.html#__next__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.iterators.peek_iter._fillcache
  pydoctor.napoleon.iterators.peek_iter.html#_fillcache
  Function
  Method
  PRIVATE
  Cache n items. If n is 0 or None, then 1 item is cached.
• pydoctor.napoleon.iterators.peek_iter.has_next
  pydoctor.napoleon.iterators.peek_iter.html#has_next
  Function
  Method
  PUBLIC
  Determine if iterator is exhausted.
• pydoctor.napoleon.iterators.peek_iter.next
  pydoctor.napoleon.iterators.peek_iter.html#next
  Function
  Method
  PUBLIC
  Get the next item or n items of the iterator.
• pydoctor.napoleon.iterators.peek_iter.peek
  pydoctor.napoleon.iterators.peek_iter.html#peek
  Function
  Method
  PUBLIC
  Preview the next item or n items of the iterator. The iterator is not advanced when peek is called.
• pydoctor.napoleon.iterators.modify_iter
  pydoctor.napoleon.iterators.modify_iter.html
  Class
  Class
  PUBLIC
  An iterator object that supports modifying items as they are returned.
• pydoctor.napoleon.iterators.modify_iter.modifier
  pydoctor.napoleon.iterators.modify_iter.html#modifier
  Attribute
  Instance Variable
  PUBLIC
  modifier is called with each item in o as it is iterated. The return value of modifier is returned in lieu of the item. Values returned by peek as well as next are affected by modifier. However, sentinel...
• pydoctor.napoleon.iterators.modify_iter.__init__
  pydoctor.napoleon.iterators.modify_iter.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.napoleon.iterators.modify_iter._fillcache
  pydoctor.napoleon.iterators.modify_iter.html#_fillcache
  Function
  Method
  PRIVATE
  Cache n modified items. If n is 0 or None, 1 item is cached. Each item returned by the iterator is passed through the modify_iter.modifier function before being cached.
• pydoctor.templatewriter.pages.sidebar.SideBar
  pydoctor.templatewriter.pages.sidebar.SideBar.html
  Class
  Class
  PUBLIC
  Sidebar.
• pydoctor.templatewriter.pages.sidebar.SideBar.filename
  pydoctor.templatewriter.pages.sidebar.SideBar.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBar.__init__
  pydoctor.templatewriter.pages.sidebar.SideBar.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBar.ob
  pydoctor.templatewriter.pages.sidebar.SideBar.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBar.template_lookup
  pydoctor.templatewriter.pages.sidebar.SideBar.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBar.sections
  pydoctor.templatewriter.pages.sidebar.SideBar.html#sections
  Function
  Method
  PUBLIC
  Sections are SideBarSection elements.
• pydoctor.templatewriter.pages.sidebar.SideBarSection
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html
  Class
  Class
  PUBLIC
  Main sidebar section.
• pydoctor.templatewriter.pages.sidebar.SideBarSection.__init__
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBarSection.ob
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBarSection.documented_ob
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#documented_ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBarSection.template_lookup
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBarSection._represents_documented_ob
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#_represents_documented_ob
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBarSection.kind
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#kind
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.SideBarSection.name
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#name
  Function
  Method
  PUBLIC
  Craft a <code><a> block for the title with custom description when hovering.
• pydoctor.templatewriter.pages.sidebar.SideBarSection.description
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#description
  Function
  Method
  PUBLIC
  Short description of the sidebar section.
• pydoctor.templatewriter.pages.sidebar.SideBarSection.content
  pydoctor.templatewriter.pages.sidebar.SideBarSection.html#content
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent
  pydoctor.templatewriter.pages.sidebar.ObjContent.html
  Class
  Class
  PUBLIC
  Object content displayed on the sidebar.
• pydoctor.templatewriter.pages.sidebar.ObjContent.__init__
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.ob
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.documented_ob
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#documented_ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.template_lookup
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent._order
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#_order
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent._depth
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#_depth
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent._level
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#_level
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.classList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#classList
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.functionList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#functionList
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.variableList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#variableList
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.subModuleList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#subModuleList
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.inheritedFunctionList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#inheritedFunctionList
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.inheritedVariableList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#inheritedVariableList
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent._getContentList
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#_getContentList
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent._children
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#_children
  Function
  Method
  PRIVATE
  Compute the children of this object.
• pydoctor.templatewriter.pages.sidebar.ObjContent._isExpandable
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#_isExpandable
  Function
  Method
  PRIVATE
  Should the list items be expandable?
• pydoctor.templatewriter.pages.sidebar.ObjContent.docstringToc
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#docstringToc
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.classesTitle
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#classesTitle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.classes
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#classes
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.functionsTitle
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#functionsTitle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.functions
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#functions
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.inheritedFunctionsTitle
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#inheritedFunctionsTitle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.inheritedFunctions
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#inheritedFunctions
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.variablesTitle
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#variablesTitle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.variables
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#variables
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.inheritedVariablesTitle
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#inheritedVariablesTitle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.inheritedVariables
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#inheritedVariables
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.subModulesTitle
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#subModulesTitle
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.subModules
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#subModules
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ObjContent.has_contents
  pydoctor.templatewriter.pages.sidebar.ObjContent.html#has_contents
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList
  pydoctor.templatewriter.pages.sidebar.ContentList.html
  Class
  Class
  PUBLIC
  List of child objects that share the same type.
• pydoctor.templatewriter.pages.sidebar.ContentList.filename
  pydoctor.templatewriter.pages.sidebar.ContentList.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.__init__
  pydoctor.templatewriter.pages.sidebar.ContentList.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.ob
  pydoctor.templatewriter.pages.sidebar.ContentList.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.children
  pydoctor.templatewriter.pages.sidebar.ContentList.html#children
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.documented_ob
  pydoctor.templatewriter.pages.sidebar.ContentList.html#documented_ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList._expand
  pydoctor.templatewriter.pages.sidebar.ContentList.html#_expand
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList._level_depth
  pydoctor.templatewriter.pages.sidebar.ContentList.html#_level_depth
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.nested_content_loader
  pydoctor.templatewriter.pages.sidebar.ContentList.html#nested_content_loader
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.template_lookup
  pydoctor.templatewriter.pages.sidebar.ContentList.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentList.items
  pydoctor.templatewriter.pages.sidebar.ContentList.html#items
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem
  pydoctor.templatewriter.pages.sidebar.ContentItem.html
  Class
  Class
  PUBLIC
  ContentList item.
• pydoctor.templatewriter.pages.sidebar.ContentItem.__init__
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.child
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#child
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.ob
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.documented_ob
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#documented_ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem._expand
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#_expand
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem._level_depth
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#_level_depth
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.nested_content_loader
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#nested_content_loader
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.template_lookup
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.class_
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#class_
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem._contents
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#_contents
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.expandableItem
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#expandableItem
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ContentItem.linkOnlyItem
  pydoctor.templatewriter.pages.sidebar.ContentItem.html#linkOnlyItem
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.LinkOnlyItem
  pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.html
  Class
  Class
  PUBLIC
  Sidebar leaf item: just a link to an object.
• pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.__init__
  pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.child
  pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.html#child
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.documented_ob
  pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.html#documented_ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.name
  pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.html#name
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html
  Class
  Class
  PUBLIC
  Sidebar expandable item: link to an object and have a triangle that expand/collapse it's contents
• pydoctor.templatewriter.pages.sidebar.ExpandableItem.last_ExpandableItem_id
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#last_ExpandableItem_id
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem.__init__
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem._contents
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#_contents
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem._do_not_expand
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#_do_not_expand
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem._id
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#_id
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem.labelClass
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#labelClass
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem.contents
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#contents
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem.expandableItemId
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#expandableItemId
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.sidebar.ExpandableItem.labelForExpandableItemId
  pydoctor.templatewriter.pages.sidebar.ExpandableItem.html#labelForExpandableItemId
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.filename
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.__init__
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.docgetter
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#docgetter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.ob
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild._functionExtras
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#_functionExtras
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.class_
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#class_
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.functionAnchor
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#functionAnchor
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.shortFunctionAnchor
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#shortFunctionAnchor
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.anchorHref
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#anchorHref
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.decorator
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#decorator
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.attribute
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#attribute
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.sourceLink
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#sourceLink
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.objectExtras
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#objectExtras
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.functionBody
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#functionBody
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.attributechild.AttributeChild.constantValue
  pydoctor.templatewriter.pages.attributechild.AttributeChild.html#constantValue
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.filename
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.__init__
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.docgetter
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#docgetter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.ob
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild._functionExtras
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#_functionExtras
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.class_
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#class_
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.functionAnchor
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#functionAnchor
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.shortFunctionAnchor
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#shortFunctionAnchor
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.anchorHref
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#anchorHref
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.overloads
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#overloads
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.decorator
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#decorator
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.functionDef
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#functionDef
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.sourceLink
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#sourceLink
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.objectExtras
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#objectExtras
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.functionchild.FunctionChild.functionBody
  pydoctor.templatewriter.pages.functionchild.FunctionChild.html#functionBody
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages._format_decorators
  pydoctor.templatewriter.pages.html#_format_decorators
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.format_decorators
  pydoctor.templatewriter.pages.html#format_decorators
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.format_signature
  pydoctor.templatewriter.pages.html#format_signature
  Function
  Function
  PUBLIC
  Return a stan representation of a nicely-formatted source-like function signature for the given Function. Arguments default values are linked to the appropriate objects when possible.
• pydoctor.templatewriter.pages.format_class_signature
  pydoctor.templatewriter.pages.html#format_class_signature
  Function
  Function
  PUBLIC
  The class signature is the formatted list of bases this class extends. It's not the class constructor.
• pydoctor.templatewriter.pages.LONG_SIGNATURE
  pydoctor.templatewriter.pages.html#LONG_SIGNATURE
  Attribute
  Constant
  PUBLIC
  Maximum size of a function definition to be rendered on a single line. The multiline formatting is only applied at the CSS level to stay customizable. We add a css class to the signature HTML to signify the signature could possibly be better formatted on several lines.
• pydoctor.templatewriter.pages.format_overloads
  pydoctor.templatewriter.pages.html#format_overloads
  Function
  Function
  PUBLIC
  Format a function overloads definitions as nice HTML signatures.
• pydoctor.templatewriter.pages._nbsp
  pydoctor.templatewriter.pages.html#_nbsp
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.format_function_def
  pydoctor.templatewriter.pages.html#format_function_def
  Function
  Function
  PUBLIC
  Format a function definition as nice HTML signature.
• pydoctor.templatewriter.pages.Nav
  pydoctor.templatewriter.pages.Nav.html
  Class
  Class
  PUBLIC
  Common navigation header.
• pydoctor.templatewriter.pages.Nav.filename
  pydoctor.templatewriter.pages.Nav.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Head
  pydoctor.templatewriter.pages.Head.html
  Class
  Class
  PUBLIC
  Common metadata.
• pydoctor.templatewriter.pages.Head.filename
  pydoctor.templatewriter.pages.Head.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Head.__init__
  pydoctor.templatewriter.pages.Head.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Head._title
  pydoctor.templatewriter.pages.Head.html#_title
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.Head._baseurl
  pydoctor.templatewriter.pages.Head.html#_baseurl
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.Head._pageurl
  pydoctor.templatewriter.pages.Head.html#_pageurl
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.Head.canonicalurl
  pydoctor.templatewriter.pages.Head.html#canonicalurl
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Head.title
  pydoctor.templatewriter.pages.Head.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page
  pydoctor.templatewriter.pages.Page.html
  Class
  Class
  PUBLIC
  Abstract base class for output pages.
• pydoctor.templatewriter.pages.Page.__init__
  pydoctor.templatewriter.pages.Page.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.system
  pydoctor.templatewriter.pages.Page.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.template_lookup
  pydoctor.templatewriter.pages.Page.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.page_url
  pydoctor.templatewriter.pages.Page.html#page_url
  Attribute
  Property
  PUBLIC
  The relative page url
• pydoctor.templatewriter.pages.Page.render
  pydoctor.templatewriter.pages.Page.html#render
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.slot_map
  pydoctor.templatewriter.pages.Page.html#slot_map
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.title
  pydoctor.templatewriter.pages.Page.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.head
  pydoctor.templatewriter.pages.Page.html#head
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.nav
  pydoctor.templatewriter.pages.Page.html#nav
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.header
  pydoctor.templatewriter.pages.Page.html#header
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.subheader
  pydoctor.templatewriter.pages.Page.html#subheader
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.Page.footer
  pydoctor.templatewriter.pages.Page.html#footer
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage
  pydoctor.templatewriter.pages.CommonPage.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 property, 0/3 instance variable, 0/1 class variable, 1/18 method documented
• pydoctor.templatewriter.pages.CommonPage.filename
  pydoctor.templatewriter.pages.CommonPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.ob
  pydoctor.templatewriter.pages.CommonPage.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.__init__
  pydoctor.templatewriter.pages.CommonPage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.docgetter
  pydoctor.templatewriter.pages.CommonPage.html#docgetter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage._order
  pydoctor.templatewriter.pages.CommonPage.html#_order
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.page_url
  pydoctor.templatewriter.pages.CommonPage.html#page_url
  Attribute
  Property
  PUBLIC
  The relative page url
• pydoctor.templatewriter.pages.CommonPage.title
  pydoctor.templatewriter.pages.CommonPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.heading
  pydoctor.templatewriter.pages.CommonPage.html#heading
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.category
  pydoctor.templatewriter.pages.CommonPage.html#category
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.namespace
  pydoctor.templatewriter.pages.CommonPage.html#namespace
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.inhierarchy
  pydoctor.templatewriter.pages.CommonPage.html#inhierarchy
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.extras
  pydoctor.templatewriter.pages.CommonPage.html#extras
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.docstring
  pydoctor.templatewriter.pages.CommonPage.html#docstring
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.children
  pydoctor.templatewriter.pages.CommonPage.html#children
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.packageInitTable
  pydoctor.templatewriter.pages.CommonPage.html#packageInitTable
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.baseTables
  pydoctor.templatewriter.pages.CommonPage.html#baseTables
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.mainTable
  pydoctor.templatewriter.pages.CommonPage.html#mainTable
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.methods
  pydoctor.templatewriter.pages.CommonPage.html#methods
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.childlist
  pydoctor.templatewriter.pages.CommonPage.html#childlist
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.objectExtras
  pydoctor.templatewriter.pages.CommonPage.html#objectExtras
  Function
  Method
  PUBLIC
  Flatten each model.Documentable.extra_info list item.
• pydoctor.templatewriter.pages.CommonPage.functionBody
  pydoctor.templatewriter.pages.CommonPage.html#functionBody
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.maindivclass
  pydoctor.templatewriter.pages.CommonPage.html#maindivclass
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.sidebarcontainer
  pydoctor.templatewriter.pages.CommonPage.html#sidebarcontainer
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.CommonPage.slot_map
  pydoctor.templatewriter.pages.CommonPage.html#slot_map
  Attribute
  Property
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.source_tag
  pydoctor.templatewriter.pages.html#source_tag
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ModulePage
  pydoctor.templatewriter.pages.ModulePage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ModulePage.ob
  pydoctor.templatewriter.pages.ModulePage.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ModulePage.source_links
  pydoctor.templatewriter.pages.ModulePage.html#source_links
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ModulePage.extras
  pydoctor.templatewriter.pages.ModulePage.html#extras
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.PackagePage
  pydoctor.templatewriter.pages.PackagePage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.PackagePage.ob
  pydoctor.templatewriter.pages.PackagePage.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.PackagePage.children
  pydoctor.templatewriter.pages.PackagePage.html#children
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.PackagePage.packageInitTable
  pydoctor.templatewriter.pages.PackagePage.html#packageInitTable
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.PackagePage.source_links
  pydoctor.templatewriter.pages.PackagePage.html#source_links
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.PackagePage.methods
  pydoctor.templatewriter.pages.PackagePage.html#methods
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.assembleList
  pydoctor.templatewriter.pages.html#assembleList
  Function
  Function
  PUBLIC
  Convert list of object names into a stan tree with clickable links.
• pydoctor.templatewriter.pages.ClassPage
  pydoctor.templatewriter.pages.ClassPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.ob
  pydoctor.templatewriter.pages.ClassPage.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.__init__
  pydoctor.templatewriter.pages.ClassPage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.baselists
  pydoctor.templatewriter.pages.ClassPage.html#baselists
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.extras
  pydoctor.templatewriter.pages.ClassPage.html#extras
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.classSignature
  pydoctor.templatewriter.pages.ClassPage.html#classSignature
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.inhierarchy
  pydoctor.templatewriter.pages.ClassPage.html#inhierarchy
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.baseTables
  pydoctor.templatewriter.pages.ClassPage.html#baseTables
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.baseName
  pydoctor.templatewriter.pages.ClassPage.html#baseName
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ClassPage.objectExtras
  pydoctor.templatewriter.pages.ClassPage.html#objectExtras
  Function
  Method
  PUBLIC
  Flatten each model.Documentable.extra_info list item.
• pydoctor.templatewriter.pages.get_override_info
  pydoctor.templatewriter.pages.html#get_override_info
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ZopeInterfaceClassPage
  pydoctor.templatewriter.pages.ZopeInterfaceClassPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ZopeInterfaceClassPage.ob
  pydoctor.templatewriter.pages.ZopeInterfaceClassPage.html#ob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ZopeInterfaceClassPage.extras
  pydoctor.templatewriter.pages.ZopeInterfaceClassPage.html#extras
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ZopeInterfaceClassPage.interfaceMeth
  pydoctor.templatewriter.pages.ZopeInterfaceClassPage.html#interfaceMeth
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.pages.ZopeInterfaceClassPage.objectExtras
  pydoctor.templatewriter.pages.ZopeInterfaceClassPage.html#objectExtras
  Function
  Method
  PUBLIC
  Flatten each model.Documentable.extra_info list item.
• pydoctor.templatewriter.pages.commonpages
  pydoctor.templatewriter.pages.html#commonpages
  Attribute
  Constant
  PUBLIC
  List all page classes: ties documentable class name with the page class used for rendering
• pydoctor.templatewriter.summary.moduleSummary
  pydoctor.templatewriter.summary.html#moduleSummary
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary._lckey
  pydoctor.templatewriter.summary.html#_lckey
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.templatewriter.summary.ModuleIndexPage
  pydoctor.templatewriter.summary.ModuleIndexPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ModuleIndexPage.filename
  pydoctor.templatewriter.summary.ModuleIndexPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ModuleIndexPage.__init__
  pydoctor.templatewriter.summary.ModuleIndexPage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ModuleIndexPage.title
  pydoctor.templatewriter.summary.ModuleIndexPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ModuleIndexPage.stuff
  pydoctor.templatewriter.summary.ModuleIndexPage.html#stuff
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ModuleIndexPage.heading
  pydoctor.templatewriter.summary.ModuleIndexPage.html#heading
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.findRootClasses
  pydoctor.templatewriter.summary.html#findRootClasses
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.isPrivate
  pydoctor.templatewriter.summary.html#isPrivate
  Function
  Function
  PUBLIC
  Is the object itself private or does it live in a private context?
• pydoctor.templatewriter.summary.isClassNodePrivate
  pydoctor.templatewriter.summary.html#isClassNodePrivate
  Function
  Function
  PUBLIC
  Are a class and all its subclasses are private?
• pydoctor.templatewriter.summary.subclassesFrom
  pydoctor.templatewriter.summary.html#subclassesFrom
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ClassIndexPage
  pydoctor.templatewriter.summary.ClassIndexPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ClassIndexPage.filename
  pydoctor.templatewriter.summary.ClassIndexPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ClassIndexPage.__init__
  pydoctor.templatewriter.summary.ClassIndexPage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ClassIndexPage.title
  pydoctor.templatewriter.summary.ClassIndexPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ClassIndexPage.stuff
  pydoctor.templatewriter.summary.ClassIndexPage.html#stuff
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.ClassIndexPage.heading
  pydoctor.templatewriter.summary.ClassIndexPage.html#heading
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement
  pydoctor.templatewriter.summary.LetterElement.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement.__init__
  pydoctor.templatewriter.summary.LetterElement.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement.initials
  pydoctor.templatewriter.summary.LetterElement.html#initials
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement.my_letter
  pydoctor.templatewriter.summary.LetterElement.html#my_letter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement.letter
  pydoctor.templatewriter.summary.LetterElement.html#letter
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement.letterlinks
  pydoctor.templatewriter.summary.LetterElement.html#letterlinks
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.LetterElement.names
  pydoctor.templatewriter.summary.LetterElement.html#names
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage
  pydoctor.templatewriter.summary.NameIndexPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage.filename
  pydoctor.templatewriter.summary.NameIndexPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage.__init__
  pydoctor.templatewriter.summary.NameIndexPage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage.initials
  pydoctor.templatewriter.summary.NameIndexPage.html#initials
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage.title
  pydoctor.templatewriter.summary.NameIndexPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage.heading
  pydoctor.templatewriter.summary.NameIndexPage.html#heading
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.NameIndexPage.index
  pydoctor.templatewriter.summary.NameIndexPage.html#index
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.IndexPage
  pydoctor.templatewriter.summary.IndexPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.IndexPage.filename
  pydoctor.templatewriter.summary.IndexPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.IndexPage.title
  pydoctor.templatewriter.summary.IndexPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.IndexPage.roots
  pydoctor.templatewriter.summary.IndexPage.html#roots
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.IndexPage.rootkind
  pydoctor.templatewriter.summary.IndexPage.html#rootkind
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.hasdocstring
  pydoctor.templatewriter.summary.html#hasdocstring
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.UndocumentedSummaryPage
  pydoctor.templatewriter.summary.UndocumentedSummaryPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.UndocumentedSummaryPage.filename
  pydoctor.templatewriter.summary.UndocumentedSummaryPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.UndocumentedSummaryPage.__init__
  pydoctor.templatewriter.summary.UndocumentedSummaryPage.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.UndocumentedSummaryPage.title
  pydoctor.templatewriter.summary.UndocumentedSummaryPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.UndocumentedSummaryPage.heading
  pydoctor.templatewriter.summary.UndocumentedSummaryPage.html#heading
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.UndocumentedSummaryPage.stuff
  pydoctor.templatewriter.summary.UndocumentedSummaryPage.html#stuff
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.HelpPage
  pydoctor.templatewriter.summary.HelpPage.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.HelpPage.filename
  pydoctor.templatewriter.summary.HelpPage.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.HelpPage.RST_SOURCE_TEMPLATE
  pydoctor.templatewriter.summary.HelpPage.html#RST_SOURCE_TEMPLATE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.HelpPage.title
  pydoctor.templatewriter.summary.HelpPage.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.HelpPage.heading
  pydoctor.templatewriter.summary.HelpPage.html#heading
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.HelpPage.helpcontent
  pydoctor.templatewriter.summary.HelpPage.html#helpcontent
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.summary.summaryPages
  pydoctor.templatewriter.summary.html#summaryPages
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.get_all_documents_flattenable
  pydoctor.templatewriter.search.html#get_all_documents_flattenable
  Function
  Function
  PUBLIC
  Get a generator for all data to be writen into ``all-documents.html`` file.
• pydoctor.templatewriter.search.AllDocuments
  pydoctor.templatewriter.search.AllDocuments.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.AllDocuments.filename
  pydoctor.templatewriter.search.AllDocuments.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.AllDocuments.title
  pydoctor.templatewriter.search.AllDocuments.html#title
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.AllDocuments.documents
  pydoctor.templatewriter.search.AllDocuments.html#documents
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter
  pydoctor.templatewriter.search.LunrIndexWriter.html
  Class
  Class
  PUBLIC
  Class to write lunr indexes with configurable fields.
• pydoctor.templatewriter.search.LunrIndexWriter.output_file
  pydoctor.templatewriter.search.LunrIndexWriter.html#output_file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.system
  pydoctor.templatewriter.search.LunrIndexWriter.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.fields
  pydoctor.templatewriter.search.LunrIndexWriter.html#fields
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter._BOOSTS
  pydoctor.templatewriter.search.LunrIndexWriter.html#_BOOSTS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter._SKIP_PIPELINES
  pydoctor.templatewriter.search.LunrIndexWriter.html#_SKIP_PIPELINES
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.get_ob_boost
  pydoctor.templatewriter.search.LunrIndexWriter.html#get_ob_boost
  Function
  Static Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.format
  pydoctor.templatewriter.search.LunrIndexWriter.html#format
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.format_name
  pydoctor.templatewriter.search.LunrIndexWriter.html#format_name
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.format_names
  pydoctor.templatewriter.search.LunrIndexWriter.html#format_names
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.format_qname
  pydoctor.templatewriter.search.LunrIndexWriter.html#format_qname
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.format_docstring
  pydoctor.templatewriter.search.LunrIndexWriter.html#format_docstring
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.format_kind
  pydoctor.templatewriter.search.LunrIndexWriter.html#format_kind
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.get_corpus
  pydoctor.templatewriter.search.LunrIndexWriter.html#get_corpus
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.LunrIndexWriter.write
  pydoctor.templatewriter.search.LunrIndexWriter.html#write
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.write_lunr_index
  pydoctor.templatewriter.search.html#write_lunr_index
  Function
  Function
  PUBLIC
  Write ``searchindex.json`` and ``fullsearchindex.json`` to the output directory.
• pydoctor.templatewriter.search.stem_identifier
  pydoctor.templatewriter.search.html#stem_identifier
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.templatewriter.search.searchpages
  pydoctor.templatewriter.search.html#searchpages
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.writer.flattenToFile
  pydoctor.templatewriter.writer.html#flattenToFile
  Function
  Function
  PUBLIC
  This method writes a page to a HTML file.
• pydoctor.templatewriter.TemplateWriter
  pydoctor.templatewriter.TemplateWriter.html
  Class
  Class
  PUBLIC
  HTML templates writer.
• pydoctor.templatewriter.TemplateWriter.__subclasshook__
  pydoctor.templatewriter.TemplateWriter.html#__subclasshook__
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.templatewriter.TemplateWriter.__init__
  pydoctor.templatewriter.TemplateWriter.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.templatewriter.TemplateWriter.build_directory
  pydoctor.templatewriter.TemplateWriter.html#build_directory
  Attribute
  Instance Variable
  PUBLIC
  Build directory
• pydoctor.templatewriter.TemplateWriter.template_lookup
  pydoctor.templatewriter.TemplateWriter.html#template_lookup
  Attribute
  Instance Variable
  PUBLIC
  Writer's TemplateLookup object
• pydoctor.templatewriter.TemplateWriter.written_pages
  pydoctor.templatewriter.TemplateWriter.html#written_pages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.TemplateWriter.total_pages
  pydoctor.templatewriter.TemplateWriter.html#total_pages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.TemplateWriter.dry_run
  pydoctor.templatewriter.TemplateWriter.html#dry_run
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.templatewriter.TemplateWriter.prepOutputDirectory
  pydoctor.templatewriter.TemplateWriter.html#prepOutputDirectory
  Function
  Method
  PUBLIC
  Write static CSS and JS files to build directory.
• pydoctor.templatewriter.TemplateWriter.writeIndividualFiles
  pydoctor.templatewriter.TemplateWriter.html#writeIndividualFiles
  Function
  Method
  PUBLIC
  Iterate through obs and call _writeDocsFor method for each Documentable.
• pydoctor.templatewriter.TemplateWriter.writeSummaryPages
  pydoctor.templatewriter.TemplateWriter.html#writeSummaryPages
  Function
  Method
  PUBLIC
  Called second.
• pydoctor.templatewriter.TemplateWriter.writeLinks
  pydoctor.templatewriter.TemplateWriter.html#writeLinks
  Function
  Method
  PUBLIC
  Called after writeIndividualFiles when option --html-subject is not used.
• pydoctor.templatewriter.TemplateWriter._writeDocsFor
  pydoctor.templatewriter.TemplateWriter.html#_writeDocsFor
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.templatewriter.TemplateWriter._writeDocsForOne
  pydoctor.templatewriter.TemplateWriter.html#_writeDocsForOne
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.options.BUILDTIME_FORMAT
  pydoctor.options.html#BUILDTIME_FORMAT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.BUILDTIME_FORMAT_HELP
  pydoctor.options.html#BUILDTIME_FORMAT_HELP
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.DEFAULT_CONFIG_FILES
  pydoctor.options.html#DEFAULT_CONFIG_FILES
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.CONFIG_SECTIONS
  pydoctor.options.html#CONFIG_SECTIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.DEFAULT_SYSTEM
  pydoctor.options.html#DEFAULT_SYSTEM
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.PydoctorConfigParser
  pydoctor.options.html#PydoctorConfigParser
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.options.get_parser
  pydoctor.options.html#get_parser
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.options.parse_args
  pydoctor.options.html#parse_args
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.options._warn_deprecated_options
  pydoctor.options.html#_warn_deprecated_options
  Function
  Function
  PRIVATE
  Check the CLI options and warn on deprecated options.
• pydoctor.options._convert_sourcepath
  pydoctor.options.html#_convert_sourcepath
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._convert_templatedir
  pydoctor.options.html#_convert_templatedir
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._convert_projectbasedirectory
  pydoctor.options.html#_convert_projectbasedirectory
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._convert_systemclass
  pydoctor.options.html#_convert_systemclass
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._convert_htmlwriter
  pydoctor.options.html#_convert_htmlwriter
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._convert_privacy
  pydoctor.options.html#_convert_privacy
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._convert_htmlbaseurl
  pydoctor.options.html#_convert_htmlbaseurl
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options.IntersphinxSource
  pydoctor.options.IntersphinxSource.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.options.IntersphinxSource.source
  pydoctor.options.IntersphinxSource.html#source
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.options.IntersphinxSource.base_url
  pydoctor.options.IntersphinxSource.html#base_url
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• pydoctor.options.IntersphinxSource.__str__
  pydoctor.options.IntersphinxSource.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.options._parse_intersphinx
  pydoctor.options.html#_parse_intersphinx
  Function
  Function
  PRIVATE
  Function returning a tuple (inventory file, base_url) for the intersphinx-file commandline argument. Used double commas because the simple comma might conflict with windows drive names.
• pydoctor.options._convert_intersphinx
  pydoctor.options.html#_convert_intersphinx
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.options._RECOGNIZED_SOURCE_HREF
  pydoctor.options.html#_RECOGNIZED_SOURCE_HREF
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.options._get_viewsource_template
  pydoctor.options.html#_get_viewsource_template
  Function
  Function
  PRIVATE
  Recognize several version control providers based on option --html-viewsource-base.
• pydoctor.options.Options
  pydoctor.options.Options.html
  Class
  Class
  PUBLIC
  Container for all possible pydoctor options.
• pydoctor.options.Options.MAKE_HTML_DEFAULT
  pydoctor.options.Options.html#MAKE_HTML_DEFAULT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.Options.HTML_SOURCE_TEMPLATE_DEFAULT
  pydoctor.options.Options.html#HTML_SOURCE_TEMPLATE_DEFAULT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.options.Options.sourcepath
  pydoctor.options.Options.html#sourcepath
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.systemclass
  pydoctor.options.Options.html#systemclass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.projectname
  pydoctor.options.Options.html#projectname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.projectversion
  pydoctor.options.Options.html#projectversion
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.projecturl
  pydoctor.options.Options.html#projecturl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.projectbasedirectory
  pydoctor.options.Options.html#projectbasedirectory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.testing
  pydoctor.options.Options.html#testing
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.pdb
  pydoctor.options.Options.html#pdb
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.makehtml
  pydoctor.options.Options.html#makehtml
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.makeintersphinx
  pydoctor.options.Options.html#makeintersphinx
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.prependedpackage
  pydoctor.options.Options.html#prependedpackage
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.docformat
  pydoctor.options.Options.html#docformat
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.theme
  pydoctor.options.Options.html#theme
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.processtypes
  pydoctor.options.Options.html#processtypes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.templatedir
  pydoctor.options.Options.html#templatedir
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.privacy
  pydoctor.options.Options.html#privacy
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmlsubjects
  pydoctor.options.Options.html#htmlsubjects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmlsummarypages
  pydoctor.options.Options.html#htmlsummarypages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmloutput
  pydoctor.options.Options.html#htmloutput
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmlwriter
  pydoctor.options.Options.html#htmlwriter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmlsourcebase
  pydoctor.options.Options.html#htmlsourcebase
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmlsourcetemplate
  pydoctor.options.Options.html#htmlsourcetemplate
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.htmlbaseurl
  pydoctor.options.Options.html#htmlbaseurl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.buildtime
  pydoctor.options.Options.html#buildtime
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.warnings_as_errors
  pydoctor.options.Options.html#warnings_as_errors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.verbosity
  pydoctor.options.Options.html#verbosity
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.quietness
  pydoctor.options.Options.html#quietness
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.introspect_c_modules
  pydoctor.options.Options.html#introspect_c_modules
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.intersphinx
  pydoctor.options.Options.html#intersphinx
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.enable_intersphinx_cache
  pydoctor.options.Options.html#enable_intersphinx_cache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.intersphinx_cache_path
  pydoctor.options.Options.html#intersphinx_cache_path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.clear_intersphinx_cache
  pydoctor.options.Options.html#clear_intersphinx_cache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.intersphinx_cache_max_age
  pydoctor.options.Options.html#intersphinx_cache_max_age
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.intersphinx_file
  pydoctor.options.Options.html#intersphinx_file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.pyvalreprlinelen
  pydoctor.options.Options.html#pyvalreprlinelen
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.pyvalreprmaxlines
  pydoctor.options.Options.html#pyvalreprmaxlines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.sidebarexpanddepth
  pydoctor.options.Options.html#sidebarexpanddepth
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.sidebartocdepth
  pydoctor.options.Options.html#sidebartocdepth
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.nosidebar
  pydoctor.options.Options.html#nosidebar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.cls_member_order
  pydoctor.options.Options.html#cls_member_order
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.mod_member_order
  pydoctor.options.Options.html#mod_member_order
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.use_hardlinks
  pydoctor.options.Options.html#use_hardlinks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.options.Options.__attrs_post_init__
  pydoctor.options.Options.html#__attrs_post_init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.options.Options.defaults
  pydoctor.options.Options.html#defaults
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.options.Options.from_args
  pydoctor.options.Options.html#from_args
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.options.Options.from_namespace
  pydoctor.options.Options.html#from_namespace
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.driver.get_system
  pydoctor.driver.html#get_system
  Function
  Function
  PUBLIC
  Get a system with the defined options. Load packages and modules.
• pydoctor.driver.make
  pydoctor.driver.html#make
  Function
  Function
  PUBLIC
  Produce the html/intersphinx output, as configured in the system's options.
• pydoctor.driver.main
  pydoctor.driver.html#main
  Function
  Function
  PUBLIC
  This is the console_scripts entry point for pydoctor CLI.
• pydoctor.napoleon.docstring._directive_regex
  pydoctor.napoleon.docstring.html#_directive_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._google_section_regex
  pydoctor.napoleon.docstring.html#_google_section_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._google_typed_arg_regex
  pydoctor.napoleon.docstring.html#_google_typed_arg_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._numpy_section_regex
  pydoctor.napoleon.docstring.html#_numpy_section_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._single_colon_regex
  pydoctor.napoleon.docstring.html#_single_colon_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._xref_or_code_regex
  pydoctor.napoleon.docstring.html#_xref_or_code_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._xref_regex
  pydoctor.napoleon.docstring.html#_xref_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._bullet_list_regex
  pydoctor.napoleon.docstring.html#_bullet_list_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring._enumerated_list_regex
  pydoctor.napoleon.docstring.html#_enumerated_list_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.Field
  pydoctor.napoleon.docstring.Field.html
  Class
  Class
  PUBLIC
  Represent a field with a name and/or a type and/or a description. Commonly a parameter description. It's also used for Returns section and other sections structured with fields.
• pydoctor.napoleon.docstring.Field.name
  pydoctor.napoleon.docstring.Field.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name of the parameter or return value, can be empty. Let's note that Field.name is not the field_name in the docutils sense (i.e. "param" or "type"). But the actual parameter name.
• pydoctor.napoleon.docstring.Field.type
  pydoctor.napoleon.docstring.Field.html#type
  Attribute
  Instance Variable
  PUBLIC
  The enventual type of the parameter/return value.
• pydoctor.napoleon.docstring.Field.content
  pydoctor.napoleon.docstring.Field.html#content
  Attribute
  Instance Variable
  PUBLIC
  The content of the field.
• pydoctor.napoleon.docstring.Field.lineno
  pydoctor.napoleon.docstring.Field.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Line number of the field relative to the begening of the docstring.
• pydoctor.napoleon.docstring.Field.__bool__
  pydoctor.napoleon.docstring.Field.html#__bool__
  Function
  Method
  PUBLIC
  Returns True if the field has any kind of content.
• pydoctor.napoleon.docstring.is_obj_identifier
  pydoctor.napoleon.docstring.html#is_obj_identifier
  Function
  Function
  PUBLIC
  Is this string a Python object(s) identifier?
• pydoctor.napoleon.docstring.is_type
  pydoctor.napoleon.docstring.html#is_type
  Function
  Function
  PUBLIC
  Is this string a type expression that can be parsed by TypeDocstring without generating any warnings?
• pydoctor.napoleon.docstring.is_google_typed_arg
  pydoctor.napoleon.docstring.html#is_google_typed_arg
  Function
  Function
  PUBLIC
  Is this string a valid type expression and/or google-style field name and type expression in parenthesis?
• pydoctor.napoleon.docstring.TokenType
  pydoctor.napoleon.docstring.TokenType.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.LITERAL
  pydoctor.napoleon.docstring.TokenType.html#LITERAL
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.OBJ
  pydoctor.napoleon.docstring.TokenType.html#OBJ
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.DELIMITER
  pydoctor.napoleon.docstring.TokenType.html#DELIMITER
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.CONTROL
  pydoctor.napoleon.docstring.TokenType.html#CONTROL
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.REFERENCE
  pydoctor.napoleon.docstring.TokenType.html#REFERENCE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.UNKNOWN
  pydoctor.napoleon.docstring.TokenType.html#UNKNOWN
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TokenType.ANY
  pydoctor.napoleon.docstring.TokenType.html#ANY
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring._T
  pydoctor.napoleon.docstring.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.Token
  pydoctor.napoleon.docstring.Token.html
  Class
  Class
  PUBLIC
  A token in a type specification.
• pydoctor.napoleon.docstring.Token.value
  pydoctor.napoleon.docstring.Token.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.Token.type
  pydoctor.napoleon.docstring.Token.html#type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.Token.astext
  pydoctor.napoleon.docstring.Token.html#astext
  Function
  Method
  PUBLIC
  The token as text.
• pydoctor.napoleon.docstring.ITokenizer
  pydoctor.napoleon.docstring.ITokenizer.html
  Class
  Class
  PUBLIC
  A tokenizer for annotations.
• pydoctor.napoleon.docstring.ITokenizer.warnings
  pydoctor.napoleon.docstring.ITokenizer.html#warnings
  Attribute
  Class Variable
  PUBLIC
  The warnings trigered during the tokenization.
• pydoctor.napoleon.docstring.ITokenizer.tokens
  pydoctor.napoleon.docstring.ITokenizer.html#tokens
  Attribute
  Class Variable
  PUBLIC
  The tokens.
• pydoctor.napoleon.docstring.ITokenizer.__init__
  pydoctor.napoleon.docstring.ITokenizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.Tokenizer
  pydoctor.napoleon.docstring.Tokenizer.html
  Class
  Class
  PUBLIC
  A tokenizer for string annotations.
• pydoctor.napoleon.docstring.Tokenizer.__init__
  pydoctor.napoleon.docstring.Tokenizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.Tokenizer.warnings
  pydoctor.napoleon.docstring.Tokenizer.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  The warnings trigered during the tokenization.
• pydoctor.napoleon.docstring.Tokenizer.tokens
  pydoctor.napoleon.docstring.Tokenizer.html#tokens
  Attribute
  Instance Variable
  PUBLIC
  The tokens.
• pydoctor.napoleon.docstring.Tokenizer._additional_warnings
  pydoctor.napoleon.docstring.Tokenizer.html#_additional_warnings
  Function
  Static Method
  PRIVATE
  Some more warnings.
• pydoctor.napoleon.docstring.Tokenizer.build
  pydoctor.napoleon.docstring.Tokenizer.html#build
  Function
  Class Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.Tokenizer.recombine_sets
  pydoctor.napoleon.docstring.Tokenizer.html#recombine_sets
  Function
  Static Method
  PUBLIC
  Merge the special literal choices tokens together.
• pydoctor.napoleon.docstring.Tokenizer.tokenize_str
  pydoctor.napoleon.docstring.Tokenizer.html#tokenize_str
  Function
  Static Method
  PUBLIC
  Split the string in tokens for further processing.
• pydoctor.napoleon.docstring.Tokenizer._token_type
  pydoctor.napoleon.docstring.Tokenizer.html#_token_type
  Function
  Static Method
  PRIVATE
  Find the type of a token. Types are defined in TokenType enum.
• pydoctor.napoleon.docstring.TypeDocstring
  pydoctor.napoleon.docstring.TypeDocstring.html
  Class
  Class
  PUBLIC
  Convert natural language type strings to reStructuredText.
• pydoctor.napoleon.docstring.TypeDocstring._natural_language_delimiters_regex_str
  pydoctor.napoleon.docstring.TypeDocstring.html#_natural_language_delimiters_regex_str
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring._natural_language_delimiters_regex
  pydoctor.napoleon.docstring.TypeDocstring.html#_natural_language_delimiters_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring._ast_like_delimiters_regex_str
  pydoctor.napoleon.docstring.TypeDocstring.html#_ast_like_delimiters_regex_str
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring._ast_like_delimiters_regex
  pydoctor.napoleon.docstring.TypeDocstring.html#_ast_like_delimiters_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring._token_regex
  pydoctor.napoleon.docstring.TypeDocstring.html#_token_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring._default_regex
  pydoctor.napoleon.docstring.TypeDocstring.html#_default_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring.__init__
  pydoctor.napoleon.docstring.TypeDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring._tokens
  pydoctor.napoleon.docstring.TypeDocstring.html#_tokens
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring.warnings
  pydoctor.napoleon.docstring.TypeDocstring.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.TypeDocstring.__str__
  pydoctor.napoleon.docstring.TypeDocstring.html#__str__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.napoleon.docstring.TypeDocstring._convert_type_spec_to_rst
  pydoctor.napoleon.docstring.TypeDocstring.html#_convert_type_spec_to_rst
  Function
  Static Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.FreeFormException
  pydoctor.napoleon.docstring.FreeFormException.html
  Class
  Exception
  PUBLIC
  Exception to encapsulate the converted lines when numpy-style fields get treated as free form.
• pydoctor.napoleon.docstring.FreeFormException.lines
  pydoctor.napoleon.docstring.FreeFormException.html#lines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring
  pydoctor.napoleon.docstring.GoogleDocstring.html
  Class
  Class
  PUBLIC
  Convert Google style docstrings to reStructuredText.
• pydoctor.napoleon.docstring.GoogleDocstring._name_rgx
  pydoctor.napoleon.docstring.GoogleDocstring.html#_name_rgx
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring.__init__
  pydoctor.napoleon.docstring.GoogleDocstring.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.napoleon.docstring.GoogleDocstring._what
  pydoctor.napoleon.docstring.GoogleDocstring.html#_what
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._process_type_fields
  pydoctor.napoleon.docstring.GoogleDocstring.html#_process_type_fields
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._line_iter
  pydoctor.napoleon.docstring.GoogleDocstring.html#_line_iter
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parsed_lines
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parsed_lines
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._is_in_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_is_in_section
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._section_indent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_section_indent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._sections
  pydoctor.napoleon.docstring.GoogleDocstring.html#_sections
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring.warnings
  pydoctor.napoleon.docstring.GoogleDocstring.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  Warning messages triggered during the conversion.
• pydoctor.napoleon.docstring.GoogleDocstring.__str__
  pydoctor.napoleon.docstring.GoogleDocstring.html#__str__
  Function
  Method
  PUBLIC
  Return the parsed docstring in reStructuredText format.
• pydoctor.napoleon.docstring.GoogleDocstring.lines
  pydoctor.napoleon.docstring.GoogleDocstring.html#lines
  Function
  Method
  PUBLIC
  Return the parsed lines of the docstring in reStructuredText format.
• pydoctor.napoleon.docstring.GoogleDocstring._consume_indented_block
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_indented_block
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_contiguous
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_contiguous
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_empty
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_empty
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_field
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_field
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_fields
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_fields
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_inline_attribute
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_inline_attribute
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_returns_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_returns_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_section_header
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_section_header
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_to_end
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_to_end
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._consume_to_next_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_consume_to_next_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._convert_type
  pydoctor.napoleon.docstring.GoogleDocstring.html#_convert_type
  Function
  Method
  PRIVATE
  Tokenize the string type and convert it with additional markup and auto linking, with L{TypeDocstring}.
• pydoctor.napoleon.docstring.GoogleDocstring._dedent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_dedent
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._escape_args_and_kwargs
  pydoctor.napoleon.docstring.GoogleDocstring.html#_escape_args_and_kwargs
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._fix_field_desc
  pydoctor.napoleon.docstring.GoogleDocstring.html#_fix_field_desc
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._format_admonition
  pydoctor.napoleon.docstring.GoogleDocstring.html#_format_admonition
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._format_block
  pydoctor.napoleon.docstring.GoogleDocstring.html#_format_block
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._format_docutils_params
  pydoctor.napoleon.docstring.GoogleDocstring.html#_format_docutils_params
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._format_field
  pydoctor.napoleon.docstring.GoogleDocstring.html#_format_field
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._format_fields
  pydoctor.napoleon.docstring.GoogleDocstring.html#_format_fields
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._get_current_indent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_get_current_indent
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._get_indent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_get_indent
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._get_initial_indent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_get_initial_indent
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._get_min_indent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_get_min_indent
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._indent
  pydoctor.napoleon.docstring.GoogleDocstring.html#_indent
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._is_indented
  pydoctor.napoleon.docstring.GoogleDocstring.html#_is_indented
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._is_list
  pydoctor.napoleon.docstring.GoogleDocstring.html#_is_list
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._is_section_header
  pydoctor.napoleon.docstring.GoogleDocstring.html#_is_section_header
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._is_section_break
  pydoctor.napoleon.docstring.GoogleDocstring.html#_is_section_break
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_admonition
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_admonition
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_attribute_docstring
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_attribute_docstring
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_attributes_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_attributes_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_examples_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_examples_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_generic_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_generic_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_keyword_arguments_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_keyword_arguments_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_methods_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_methods_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_notes_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_notes_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_parameters_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_parameters_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_raises_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_raises_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_references_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_references_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_returns_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_returns_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_see_also_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_see_also_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._parse_warns_section
  pydoctor.napoleon.docstring.GoogleDocstring.html#_parse_warns_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._partition_field_on_colon
  pydoctor.napoleon.docstring.GoogleDocstring.html#_partition_field_on_colon
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.GoogleDocstring._partition_multiline_field_on_colon
  pydoctor.napoleon.docstring.GoogleDocstring.html#_partition_multiline_field_on_colon
  Function
  Method
  PRIVATE
  Partition multiple lines on colon. If the type or name span multiple lines, they will be automatically joined.
• pydoctor.napoleon.docstring.GoogleDocstring._strip_empty
  pydoctor.napoleon.docstring.GoogleDocstring.html#_strip_empty
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring
  pydoctor.napoleon.docstring.NumpyDocstring.html
  Class
  Class
  PUBLIC
  Convert NumPy style docstrings to reStructuredText.
• pydoctor.napoleon.docstring.NumpyDocstring._escape_args_and_kwargs
  pydoctor.napoleon.docstring.NumpyDocstring.html#_escape_args_and_kwargs
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._consume_field
  pydoctor.napoleon.docstring.NumpyDocstring.html#_consume_field
  Function
  Method
  PRIVATE
  No summary
• pydoctor.napoleon.docstring.NumpyDocstring._consume_fields
  pydoctor.napoleon.docstring.NumpyDocstring.html#_consume_fields
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._consume_returns_section
  pydoctor.napoleon.docstring.NumpyDocstring.html#_consume_returns_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._consume_section_header
  pydoctor.napoleon.docstring.NumpyDocstring.html#_consume_section_header
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._is_section_break
  pydoctor.napoleon.docstring.NumpyDocstring.html#_is_section_break
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._is_section_header
  pydoctor.napoleon.docstring.NumpyDocstring.html#_is_section_header
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._convert_type_and_maybe_consume_free_form_field
  pydoctor.napoleon.docstring.NumpyDocstring.html#_convert_type_and_maybe_consume_free_form_field
  Function
  Method
  PRIVATE
  Same as _convert_type, but can raise FreeFormException.
• pydoctor.napoleon.docstring.NumpyDocstring._parse_see_also_section
  pydoctor.napoleon.docstring.NumpyDocstring.html#_parse_see_also_section
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.napoleon.docstring.NumpyDocstring._parse_numpydoc_see_also_section
  pydoctor.napoleon.docstring.NumpyDocstring.html#_parse_numpydoc_see_also_section
  Function
  Method
  PRIVATE
  Derived from the NumpyDoc implementation of _parse_see_also.
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html
  Class
  Class
  PUBLIC
  Parse google-style or numpy-style docstrings.
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.__init__
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html#__init__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.objclass
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html#objclass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.parse_google_docstring
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html#parse_google_docstring
  Function
  Method
  PUBLIC
  Parse the given docstring, which is formatted as Google style docstring. Return a ParsedDocstring representation of its contents.
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.parse_numpy_docstring
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html#parse_numpy_docstring
  Function
  Method
  PUBLIC
  Parse the given docstring, which is formatted as NumPy style docstring. Return a ParsedDocstring representation of its contents.
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser._parse_docstring
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html#_parse_docstring
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser._parse_docstring_obj
  pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser.html#_parse_docstring_obj
  Function
  Static Method
  PRIVATE
  Helper method to parse GoogleDocstring or NumpyDocstring objects.
• pydoctor.epydoc.markup._types.NodeTokenizer
  pydoctor.epydoc.markup._types.NodeTokenizer.html
  Class
  Class
  PUBLIC
  A type tokenizer for annotation as docutils document.
• pydoctor.epydoc.markup._types.NodeTokenizer.__init__
  pydoctor.epydoc.markup._types.NodeTokenizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._types.NodeTokenizer.warnings
  pydoctor.epydoc.markup._types.NodeTokenizer.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  The warnings trigered during the tokenization.
• pydoctor.epydoc.markup._types.NodeTokenizer.tokens
  pydoctor.epydoc.markup._types.NodeTokenizer.html#tokens
  Attribute
  Instance Variable
  PUBLIC
  The tokens.
• pydoctor.epydoc.markup._types.NodeTokenizer.tokenize_document
  pydoctor.epydoc.markup._types.NodeTokenizer.html#tokenize_document
  Function
  Static Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html
  Class
  Class
  PUBLIC
  Add ParsedDocstring interface on top of TypeDocstring and allow to parse types from nodes.Node objects, providing the --process-types option.
• pydoctor.epydoc.markup._types.ParsedTypeDocstring.FIELDS
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#FIELDS
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring.__init__
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring._tokens
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#_tokens
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring.warnings
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring._lineno
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#_lineno
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring._document
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#_document
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring.has_body
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#has_body
  Attribute
  Property
  PUBLIC
  Does this docstring have a non-empty body?
• pydoctor.epydoc.markup._types.ParsedTypeDocstring.to_node
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#to_node
  Function
  Method
  PUBLIC
  Translate this docstring to a nodes.document.
• pydoctor.epydoc.markup._types.ParsedTypeDocstring._converters
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#_converters
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup._types.ParsedTypeDocstring._parse_tokens
  pydoctor.epydoc.markup._types.ParsedTypeDocstring.html#_parse_tokens
  Function
  Method
  PRIVATE
  Convert type to docutils document object.
• pydoctor.epydoc.markup.epytext.SYMBOLS
  pydoctor.epydoc.markup.epytext.html#SYMBOLS
  Attribute
  Constant
  PUBLIC
  A list of the of escape symbols that are supported by epydoc. Currently the following symbols are supported :
• pydoctor.epydoc.markup.epytext.gettext
  pydoctor.epydoc.markup.epytext.html#gettext
  Function
  Function
  PUBLIC
  Return the text inside the epytext element(s).
• pydoctor.epydoc.markup.epytext.slugify
  pydoctor.epydoc.markup.epytext.html#slugify
  Function
  Function
  PUBLIC
  A generic slugifier utility (currently only for Latin-based scripts). Example:
• pydoctor.epydoc.markup.epytext.Element
  pydoctor.epydoc.markup.epytext.Element.html
  Class
  Class
  PUBLIC
  A very simple DOM-like representation for parsed epytext documents. Each epytext document is encoded as a tree whose nodes are Element objects, and whose leaves are strings. Each node is marked by a ...
• pydoctor.epydoc.markup.epytext.Element.__init__
  pydoctor.epydoc.markup.epytext.Element.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.Element.tag
  pydoctor.epydoc.markup.epytext.Element.html#tag
  Attribute
  Instance Variable
  PUBLIC
  A string tag indicating the type of this element.
• pydoctor.epydoc.markup.epytext.Element.children
  pydoctor.epydoc.markup.epytext.Element.html#children
  Attribute
  Instance Variable
  PUBLIC
  A list of the children of this element.
• pydoctor.epydoc.markup.epytext.Element.attribs
  pydoctor.epydoc.markup.epytext.Element.html#attribs
  Attribute
  Instance Variable
  PUBLIC
  A dictionary mapping attribute names to attribute values for this element.
• pydoctor.epydoc.markup.epytext.Element.__str__
  pydoctor.epydoc.markup.epytext.Element.html#__str__
  Function
  Method
  PUBLIC
  Return a string representation of this element, using XML notation.
• pydoctor.epydoc.markup.epytext.Element.__repr__
  pydoctor.epydoc.markup.epytext.Element.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext._HEADING_CHARS
  pydoctor.epydoc.markup.epytext.html#_HEADING_CHARS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._ESCAPES
  pydoctor.epydoc.markup.epytext.html#_ESCAPES
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._SYMBOLS
  pydoctor.epydoc.markup.epytext.html#_SYMBOLS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.symblist
  pydoctor.epydoc.markup.epytext.html#symblist
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.__doc__
  pydoctor.epydoc.markup.epytext.html#__doc__
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext._COLORIZING_TAGS
  pydoctor.epydoc.markup.epytext.html#_COLORIZING_TAGS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._LINK_COLORIZING_TAGS
  pydoctor.epydoc.markup.epytext.html#_LINK_COLORIZING_TAGS
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.parse
  pydoctor.epydoc.markup.epytext.html#parse
  Function
  Function
  PUBLIC
  Return a DOM tree encoding the contents of an epytext string. Any errors generated during parsing will be stored in errors.
• pydoctor.epydoc.markup.epytext._pop_completed_blocks
  pydoctor.epydoc.markup.epytext.html#_pop_completed_blocks
  Function
  Function
  PRIVATE
  Pop any completed blocks off the stack. This includes any blocks that we have dedented past, as well as any list item blocks that we've dedented to. The top element on the stack should only be a list if we're about to start a new list item (i...
• pydoctor.epydoc.markup.epytext._add_para
  pydoctor.epydoc.markup.epytext.html#_add_para
  Function
  Function
  PRIVATE
  Colorize the given paragraph, and add it to the DOM tree.
• pydoctor.epydoc.markup.epytext._add_section
  pydoctor.epydoc.markup.epytext.html#_add_section
  Function
  Function
  PRIVATE
  Add a new section to the DOM tree, with the given heading.
• pydoctor.epydoc.markup.epytext._add_list
  pydoctor.epydoc.markup.epytext.html#_add_list
  Function
  Function
  PRIVATE
  Add a new list item or field to the DOM tree, with the given bullet or field tag. When necessary, create the associated list.
• pydoctor.epydoc.markup.epytext.Token
  pydoctor.epydoc.markup.epytext.Token.html
  Class
  Class
  PUBLIC
  Tokens are an intermediate data structure used while constructing the structuring DOM tree for a formatted docstring. There are five types of Token:
• pydoctor.epydoc.markup.epytext.Token.tag
  pydoctor.epydoc.markup.epytext.Token.html#tag
  Attribute
  Instance Variable
  PUBLIC
  This Token's type. Possible values are Token.PARA (paragraph), Token.LBLOCK (literal block), Token.DTBLOCK (doctest block), Token.HEADINGC, and Token.BULLETC.
• pydoctor.epydoc.markup.epytext.Token.startline
  pydoctor.epydoc.markup.epytext.Token.html#startline
  Attribute
  Instance Variable
  PUBLIC
  The line on which this Token begins. This line number is only used for issuing errors.
• pydoctor.epydoc.markup.epytext.Token.contents
  pydoctor.epydoc.markup.epytext.Token.html#contents
  Attribute
  Instance Variable
  PUBLIC
  The normalized text contained in this Token.
• pydoctor.epydoc.markup.epytext.Token.indent
  pydoctor.epydoc.markup.epytext.Token.html#indent
  Attribute
  Instance Variable
  PUBLIC
  The indentation level of this Token (in number of leading spaces). A value of None indicates an unknown indentation; this is used for list items and fields that begin with one-line paragraphs.
• pydoctor.epydoc.markup.epytext.Token.level
  pydoctor.epydoc.markup.epytext.Token.html#level
  Attribute
  Instance Variable
  PUBLIC
  The heading-level of this Token if it is a heading; None, otherwise. Valid heading levels are 0, 1, and 2.
• pydoctor.epydoc.markup.epytext.Token.PARA
  pydoctor.epydoc.markup.epytext.Token.html#PARA
  Attribute
  Constant
  PUBLIC
  The tag value for paragraph Tokens.
• pydoctor.epydoc.markup.epytext.Token.LBLOCK
  pydoctor.epydoc.markup.epytext.Token.html#LBLOCK
  Attribute
  Constant
  PUBLIC
  The tag value for literal Tokens.
• pydoctor.epydoc.markup.epytext.Token.DTBLOCK
  pydoctor.epydoc.markup.epytext.Token.html#DTBLOCK
  Attribute
  Constant
  PUBLIC
  The tag value for doctest Tokens.
• pydoctor.epydoc.markup.epytext.Token.HEADING
  pydoctor.epydoc.markup.epytext.Token.html#HEADING
  Attribute
  Constant
  PUBLIC
  The tag value for heading Tokens.
• pydoctor.epydoc.markup.epytext.Token.BULLET
  pydoctor.epydoc.markup.epytext.Token.html#BULLET
  Attribute
  Constant
  PUBLIC
  The tag value for bullet Tokens. This tag value is also used for field tag Tokens, since fields function syntactically the same as list items.
• pydoctor.epydoc.markup.epytext.Token.__init__
  pydoctor.epydoc.markup.epytext.Token.html#__init__
  Function
  Method
  PUBLIC
  Create a new Token.
• pydoctor.epydoc.markup.epytext.Token.__repr__
  pydoctor.epydoc.markup.epytext.Token.html#__repr__
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.epytext.Token.to_dom
  pydoctor.epydoc.markup.epytext.Token.html#to_dom
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.epytext._ULIST_BULLET
  pydoctor.epydoc.markup.epytext.html#_ULIST_BULLET
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._OLIST_BULLET
  pydoctor.epydoc.markup.epytext.html#_OLIST_BULLET
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._FIELD_BULLET
  pydoctor.epydoc.markup.epytext.html#_FIELD_BULLET
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._BULLET_RE
  pydoctor.epydoc.markup.epytext.html#_BULLET_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._LIST_BULLET_RE
  pydoctor.epydoc.markup.epytext.html#_LIST_BULLET_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._FIELD_BULLET_RE
  pydoctor.epydoc.markup.epytext.html#_FIELD_BULLET_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._tokenize_doctest
  pydoctor.epydoc.markup.epytext.html#_tokenize_doctest
  Function
  Function
  PRIVATE
  Construct a Token containing the doctest block starting at lines[start], and append it to tokens. block_indent should be the indentation of the doctest block. Any errors generated while tokenizing the doctest block will be appended to ...
• pydoctor.epydoc.markup.epytext._tokenize_literal
  pydoctor.epydoc.markup.epytext.html#_tokenize_literal
  Function
  Function
  PRIVATE
  Construct a Token containing the literal block starting at lines[start], and append it to tokens. block_indent should be the indentation of the literal block. Any errors generated while tokenizing the literal block will be appended to ...
• pydoctor.epydoc.markup.epytext._tokenize_listart
  pydoctor.epydoc.markup.epytext.html#_tokenize_listart
  Function
  Function
  PRIVATE
  Construct Tokens for the bullet and the first paragraph of the list item (or field) starting at lines[start], and append them to tokens. bullet_indent should be the indentation of the list item. Any errors generated while tokenizing will be appended to ...
• pydoctor.epydoc.markup.epytext._tokenize_para
  pydoctor.epydoc.markup.epytext.html#_tokenize_para
  Function
  Function
  PRIVATE
  Construct a Token containing the paragraph starting at lines[start], and append it to tokens. para_indent should be the indentation of the paragraph . Any errors generated while tokenizing the paragraph will be appended to ...
• pydoctor.epydoc.markup.epytext._tokenize
  pydoctor.epydoc.markup.epytext.html#_tokenize
  Function
  Function
  PRIVATE
  Split a given formatted docstring into an ordered list of Tokens, according to the epytext markup rules.
• pydoctor.epydoc.markup.epytext._BRACE_RE
  pydoctor.epydoc.markup.epytext.html#_BRACE_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._TARGET_RE
  pydoctor.epydoc.markup.epytext.html#_TARGET_RE
  Attribute
  Constant
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext._colorize
  pydoctor.epydoc.markup.epytext.html#_colorize
  Function
  Function
  PRIVATE
  Given a string containing the contents of a paragraph, produce a DOM Element encoding that paragraph. Colorized regions are represented using DOM Elements, and text is represented using DOM Texts.
• pydoctor.epydoc.markup.epytext._colorize_link
  pydoctor.epydoc.markup.epytext.html#_colorize_link
  Function
  Function
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.TokenizationError
  pydoctor.epydoc.markup.epytext.TokenizationError.html
  Class
  Exception
  PUBLIC
  An error generated while tokenizing a formatted documentation string.
• pydoctor.epydoc.markup.epytext.StructuringError
  pydoctor.epydoc.markup.epytext.StructuringError.html
  Class
  Exception
  PUBLIC
  An error generated while structuring a formatted documentation string.
• pydoctor.epydoc.markup.epytext.ColorizingError
  pydoctor.epydoc.markup.epytext.ColorizingError.html
  Class
  Exception
  PUBLIC
  An error generated while colorizing a paragraph.
• pydoctor.epydoc.markup.epytext.ColorizingError.__init__
  pydoctor.epydoc.markup.epytext.ColorizingError.html#__init__
  Function
  Method
  PUBLIC
  Construct a new colorizing exception.
• pydoctor.epydoc.markup.epytext.ColorizingError.token
  pydoctor.epydoc.markup.epytext.ColorizingError.html#token
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ColorizingError.charnum
  pydoctor.epydoc.markup.epytext.ColorizingError.html#charnum
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ColorizingError.CONTEXT_RANGE
  pydoctor.epydoc.markup.epytext.ColorizingError.html#CONTEXT_RANGE
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ColorizingError.descr
  pydoctor.epydoc.markup.epytext.ColorizingError.html#descr
  Function
  Method
  PUBLIC
  No summary
• pydoctor.epydoc.markup.epytext.parse_docstring
  pydoctor.epydoc.markup.epytext.html#parse_docstring
  Function
  Function
  PUBLIC
  Parse the given docstring, which is formatted using epytext; and return a ParsedDocstring representation of its contents.
• pydoctor.epydoc.markup.epytext.get_parser
  pydoctor.epydoc.markup.epytext.html#get_parser
  Function
  Function
  PUBLIC
  Get the parse_docstring function.
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html
  Class
  Class
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_CODEPOINT
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#SYMBOL_TO_CODEPOINT
  Attribute
  Constant
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.__init__
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring._tree
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#_tree
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring._stan
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#_stan
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring._document
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#_document
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring._section_slugs
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#_section_slugs
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.__str__
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.has_body
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#has_body
  Attribute
  Property
  PUBLIC
  Does this docstring have a non-empty body?
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring._slugify
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#_slugify
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.to_node
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#to_node
  Function
  Method
  PUBLIC
  Translate this docstring to a nodes.document.
• pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring._to_node
  pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring.html#_to_node
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.epydoc.markup.google.get_parser
  pydoctor.epydoc.markup.google.html#get_parser
  Function
  Function
  PUBLIC
  Returns the parser function. Behaviour will depend on the documentable type and system options.
• pydoctor.epydoc.markup.numpy.get_parser
  pydoctor.epydoc.markup.numpy.html#get_parser
  Function
  Function
  PUBLIC
  Returns the parser function. Behaviour will depend on the documentable type and system options.
• pydoctor.extensions.attrs.attrs_decorator_signature
  pydoctor.extensions.attrs.html#attrs_decorator_signature
  Attribute
  Variable
  PUBLIC
  Signature of the attr.s class decorator.
• pydoctor.extensions.attrs.attrib_signature
  pydoctor.extensions.attrs.html#attrib_signature
  Attribute
  Variable
  PUBLIC
  Signature of the attr.ib function for defining class attributes.
• pydoctor.extensions.attrs.uses_auto_attribs
  pydoctor.extensions.attrs.html#uses_auto_attribs
  Function
  Function
  PUBLIC
  Does the given attr.s() decoration contain auto_attribs=True?
• pydoctor.extensions.attrs.is_attrib
  pydoctor.extensions.attrs.html#is_attrib
  Function
  Function
  PUBLIC
  Does this expression return an attr.ib?
• pydoctor.extensions.attrs.attrib_args
  pydoctor.extensions.attrs.html#attrib_args
  Function
  Function
  PUBLIC
  Get the arguments passed to an attr.ib definition.
• pydoctor.extensions.attrs.annotation_from_attrib
  pydoctor.extensions.attrs.html#annotation_from_attrib
  Function
  Function
  PUBLIC
  Get the type of an attr.ib definition.
• pydoctor.extensions.attrs.ModuleVisitor
  pydoctor.extensions.attrs.ModuleVisitor.html
  Class
  Class
  PUBLIC
  No class docstring; 1/4 method documented
• pydoctor.extensions.attrs.ModuleVisitor.visit_ClassDef
  pydoctor.extensions.attrs.ModuleVisitor.html#visit_ClassDef
  Function
  Method
  PUBLIC
  Called when a class definition is visited.
• pydoctor.extensions.attrs.ModuleVisitor._handleAttrsAssignmentInClass
  pydoctor.extensions.attrs.ModuleVisitor.html#_handleAttrsAssignmentInClass
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.extensions.attrs.ModuleVisitor._handleAttrsAssignment
  pydoctor.extensions.attrs.ModuleVisitor.html#_handleAttrsAssignment
  Function
  Method
  PRIVATE
  Undocumented
• pydoctor.extensions.attrs.ModuleVisitor.visit_Assign
  pydoctor.extensions.attrs.ModuleVisitor.html#visit_Assign
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.attrs.AttrsClass
  pydoctor.extensions.attrs.AttrsClass.html
  Class
  Class
  PUBLIC
  No class docstring; 1/1 instance variable, 0/1 method documented
• pydoctor.extensions.attrs.AttrsClass.setup
  pydoctor.extensions.attrs.AttrsClass.html#setup
  Function
  Method
  PUBLIC
  Undocumented
• pydoctor.extensions.attrs.AttrsClass.auto_attribs
  pydoctor.extensions.attrs.AttrsClass.html#auto_attribs
  Attribute
  Instance Variable
  PUBLIC
  True if this class uses the auto_attribs feature of the attrs library to automatically convert annotated fields into attributes.
• pydoctor.extensions.attrs.setup_pydoctor_extension
  pydoctor.extensions.attrs.html#setup_pydoctor_extension
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.extensions.deprecate.getDeprecated
  pydoctor.extensions.deprecate.html#getDeprecated
  Function
  Function
  PUBLIC
  With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator.
• pydoctor.extensions.deprecate.ModuleVisitor
  pydoctor.extensions.deprecate.ModuleVisitor.html
  Class
  Class
  PUBLIC
  No class docstring; 2/2 methods documented
• pydoctor.extensions.deprecate.ModuleVisitor.depart_ClassDef
  pydoctor.extensions.deprecate.ModuleVisitor.html#depart_ClassDef
  Function
  Method
  PUBLIC
  Called after a class definition is visited.
• pydoctor.extensions.deprecate.ModuleVisitor.depart_FunctionDef
  pydoctor.extensions.deprecate.ModuleVisitor.html#depart_FunctionDef
  Function
  Method
  PUBLIC
  Called after a function definition is visited.
• pydoctor.extensions.deprecate._incremental_Version_signature
  pydoctor.extensions.deprecate.html#_incremental_Version_signature
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.extensions.deprecate.versionToUsefulObject
  pydoctor.extensions.deprecate.html#versionToUsefulObject
  Function
  Function
  PUBLIC
  Change an AST Version() to a real one.
• pydoctor.extensions.deprecate._deprecation_text_with_replacement_template
  pydoctor.extensions.deprecate.html#_deprecation_text_with_replacement_template
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.extensions.deprecate._deprecation_text_without_replacement_template
  pydoctor.extensions.deprecate.html#_deprecation_text_without_replacement_template
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.extensions.deprecate._deprecated_signature
  pydoctor.extensions.deprecate.html#_deprecated_signature
  Attribute
  Variable
  PRIVATE
  Undocumented
• pydoctor.extensions.deprecate.deprecatedToUsefulText
  pydoctor.extensions.deprecate.html#deprecatedToUsefulText
  Function
  Function
  PUBLIC
  Change a @deprecated to a display string.
• pydoctor.extensions.deprecate.setup_pydoctor_extension
  pydoctor.extensions.deprecate.html#setup_pydoctor_extension
  Function
  Function
  PUBLIC
  Undocumented
• pydoctor.sphinx_ext.build_apidocs.logger
  pydoctor.sphinx_ext.build_apidocs.html#logger
  Attribute
  Variable
  PUBLIC
  Undocumented
• pydoctor.sphinx_ext.build_apidocs.on_build_finished
  pydoctor.sphinx_ext.build_apidocs.html#on_build_finished
  Function
  Function
  PUBLIC
  Called when Sphinx build is done.
• pydoctor.sphinx_ext.build_apidocs.on_builder_inited
  pydoctor.sphinx_ext.build_apidocs.html#on_builder_inited
  Function
  Function
  PUBLIC
  Called to build the API documentation HTML files and inject our own intersphinx inventory object.
• pydoctor.sphinx_ext.build_apidocs._run_pydoctor
  pydoctor.sphinx_ext.build_apidocs.html#_run_pydoctor
  Function
  Function
  PRIVATE
  Call pydoctor with arguments.
• pydoctor.sphinx_ext.build_apidocs._get_arguments
  pydoctor.sphinx_ext.build_apidocs.html#_get_arguments
  Function
  Function
  PRIVATE
  Return the resolved arguments for pydoctor build.
• pydoctor.sphinx_ext.build_apidocs.setup
  pydoctor.sphinx_ext.build_apidocs.html#setup
  Function
  Function
  PUBLIC
  Called by Sphinx when the extension is initialized.