abc.ABC
pydoctor.epydoc.markup.ParsedDocstring
- 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._types.ParsedTypeDocstring
- Add ParsedDocstring
interface on top of TypeDocstring
and allow to parse types from nodes.Node
objects, providing the --process-types option.pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring
- Undocumentedpydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring
- Undocumentedpydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring
- An encoded version of a ReStructuredText docstring. The contents of the docstring are encoded in the _document
instance variable.pydoctor.epydoc2stan.ParsedStanOnly
- A ParsedDocstring
directly constructed from stan, for caching purposes.pydoctor.model.ISystemBuilder
- Interface class for building a system.pydoctor.model.SystemBuilder
- This class is only an adapter for some System methods related to module building.pydoctor.templatewriter.Template
- Represents a pydoctor template file.pydoctor.templatewriter.HtmlTemplate
- HTML template that works with the Twisted templating system and use xml.dom.minidom
to parse the pydoctor-template-version meta tag.pydoctor.templatewriter.StaticTemplate
- Static template: no rendering, will be copied as is to build directory.pydoctor.templatewriter.TemplateElement
- Renderable element based on a template file.pydoctor.templatewriter.pages.attributechild.AttributeChild
- Undocumentedpydoctor.templatewriter.pages.functionchild.FunctionChild
- Undocumentedpydoctor.templatewriter.pages.Head
- Common metadata.pydoctor.templatewriter.pages.Nav
- Common navigation header.pydoctor.templatewriter.pages.Page
- Abstract base class for output pages.pydoctor.templatewriter.pages.CommonPage
- No class docstring; 0/2 property, 0/3 instance variable, 0/1 class variable, 1/20 method documentedpydoctor.templatewriter.pages.ClassPage
- Undocumentedpydoctor.templatewriter.pages.ZopeInterfaceClassPage
- Undocumentedpydoctor.templatewriter.pages.ModulePage
- Undocumentedpydoctor.templatewriter.pages.PackagePage
- Undocumentedpydoctor.templatewriter.search.AllDocuments
- Undocumentedpydoctor.templatewriter.summary.ClassIndexPage
- Undocumentedpydoctor.templatewriter.summary.IndexPage
- Undocumentedpydoctor.templatewriter.summary.ModuleIndexPage
- Undocumentedpydoctor.templatewriter.summary.NameIndexPage
- Undocumentedpydoctor.templatewriter.summary.UndocumentedSummaryPage
- Undocumentedpydoctor.templatewriter.pages.sidebar.ContentList
- List of child objects that share the same type.pydoctor.templatewriter.pages.table.ChildTable
- Undocumentedpydoctor.visitor.Visitor
- "Visitor" pattern abstract superclass implementation for tree traversals.pydoctor.visitor.PartialVisitor
- 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.astutils.NodeVisitor
- 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.astbuilder.ModuleVistor
- No class docstring; 0/4 instance variable, 9/39 methods, 0/3 static method, 0/1 class method documentedast.expr
pydoctor.astutils.Str
- 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.ast.NodeTransformer
pydoctor.astutils._AnnotationStringParser
- Implementation of unstring_annotation()
.pydoctor.astutils._UpgradeDeprecatedAnnotations
- Undocumentedast.NodeVisitor
pydoctor.astutils.Parentage
- Add parent attribute to ast nodes instances.collections.deque
pydoctor.mro.Dependency
- No class docstring; 1/2 property documentedconfigargparse.ConfigFileParser
pydoctor._configparser.CompositeConfigParser
- A config parser that understands multiple formats.pydoctor._configparser.IniConfigParser
- INI parser with support for sections.pydoctor._configparser.TomlConfigParser
- TOML parser with support for sections.pydoctor._configparser.ValidatorParser
- A parser that warns when unknown options are used. It must be created with a reference to the ArgumentParser object, so like:docutils.nodes.Admonition
pydoctor.epydoc.markup.restructuredtext.SeeAlso.seealso
- Custom "see also" admonition node.pydoctor.epydoc.markup.restructuredtext.VersionChange.versionmodified
- Node for version change entries. Currently used for "versionadded", "versionchanged" and "deprecated" directives.docutils.nodes.Element
pydoctor.epydoc.markup.restructuredtext.SeeAlso.seealso
- Custom "see also" admonition node.docutils.nodes.inline
pydoctor.epydoc.docutils.wbr
- Word break opportunity.docutils.nodes.NodeVisitor
pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator
- A docutils translator that removes all fields from a document, and collects them into the instance variable fieldspydoctor.epydoc.markup.SummaryExtractor
- A docutils node visitor that extracts first sentences from the first paragraph in a document.docutils.nodes.TextElement
pydoctor.epydoc.markup.restructuredtext.VersionChange.versionmodified
- Node for version change entries. Currently used for "versionadded", "versionchanged" and "deprecated" directives.docutils.nodes.title_reference
pydoctor.epydoc.docutils.obj_reference
- A reference to a documentable object.docutils.parsers.rst.Directive
pydoctor.epydoc.markup.restructuredtext.PythonCodeDirective
- 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.VersionChange
- Directive to describe a change/addition/deprecation in a specific version.docutils.parsers.rst.directives.admonitions.BaseAdmonition
pydoctor.epydoc.markup.restructuredtext.SeeAlso
- An admonition mentioning things to look at as reference.docutils.readers.standalone.Reader
pydoctor.epydoc.markup.restructuredtext._EpydocReader
- A reader that captures all errors that are generated by parsing, and appends them to a list as ParseError
.docutils.utils.Reporter
pydoctor.epydoc.markup.restructuredtext.OptimizedReporter
- 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.docutils.writers.html4css1.HTMLTranslator
pydoctor.node2stan.HTMLTranslator
- Pydoctor's HTML translator.enum.Enum
pydoctor.epydoc2stan.FieldOrigin
- Undocumentedpydoctor.model.DocLocation
- Undocumentedpydoctor.model.DocumentableKind
- Enum
containing values indicating the possible object types.pydoctor.model.PrivacyClass
- Enum
containing values indicating how private an object should be.pydoctor.model.ProcessingState
- Undocumentedpydoctor.napoleon.docstring.TokenType
- Undocumentedpydoctor.visitor.When
- This enumeration contains the different times an extension methods are called.Exception
pydoctor.astbuilder.IgnoreAssignment
- A control flow exception meaning that the assignment should not be further proccessed.pydoctor.epydoc.markup._pyval_repr._Linebreak
- A control-flow exception that is raised when PyvalColorizer generates a string containing a newline, but the state object's linebreakok variable is False.pydoctor.epydoc.markup._pyval_repr._Maxlines
- A control-flow exception that is raised when PyvalColorizer exeeds the maximum number of allowed lines.pydoctor.epydoc.markup.ParseError
- The base class for errors generated while parsing docstrings.pydoctor.epydoc.markup.epytext.ColorizingError
- An error generated while colorizing a paragraph.pydoctor.epydoc.markup.epytext.StructuringError
- An error generated while structuring a formatted documentation string.pydoctor.epydoc.markup.epytext.TokenizationError
- An error generated while tokenizing a formatted documentation string.pydoctor.epydoc.sre_constants36.error
- Exception raised for invalid regular expressions.pydoctor.epydoc.sre_parse36.Verbose
- Undocumentedpydoctor.model.SystemBuildingError
- Raised when there is a (handled) fatal error while adding modules to the builder.pydoctor.napoleon.docstring.FreeFormException
- Exception to encapsulate the converted lines when numpy-style fields get treated as free form.pydoctor.sphinx.InvalidMaxAge
- Raised when a string cannot be parsed as a maximum age.pydoctor.templatewriter.TemplateError
- Raised when there is an problem with a template. TemplateErrors are fatal.pydoctor.templatewriter.FailedToCreateTemplate
- Raised when a template could not be created because of an errorpydoctor.templatewriter.OverrideTemplateNotAllowed
- Raised when a template path overrides a path of a different type (HTML/static/directory).pydoctor.templatewriter.UnsupportedTemplateVersion
- Raised when custom template is designed for a newer version of pydoctorpydoctor.visitor.Visitor._TreePruningException
- Base class for Visitor
-related tree pruning exceptions.pydoctor.visitor.Visitor.IgnoreNode
- Comletely stop visiting the current node, extensions will not be run on that node.pydoctor.visitor.Visitor.SkipChildren
- Do not visit any children of the current node. The current node's siblings and depart_... method are not affected.pydoctor.visitor.Visitor.SkipNode
- Do not visit the current node's children, and do not call the current node's depart_... method. The extensions will still be called.int
pydoctor.epydoc.sre_constants36._NamedIntConstant
- Undocumentedpydoctor.model.LineFromAst
- Simple int
wrapper for linenumbers coming from ast analysis.pydoctor.model.LineFromDocstringField
- Simple int
wrapper for linenumbers coming from docstrings.object
pydoctor.astutils.op_util.Precedence
- Undocumentedpydoctor.astbuilder._ValueFormatter
- Class to encapsulate a python value and translate it to HTML when calling repr()
on the _ValueFormatter
. Used for presenting default values of parameters.pydoctor.astbuilder._AnnotationValueFormatter
- Special _ValueFormatter
for function annotations.pydoctor.astbuilder.ASTBuilder
- Keeps tracks of the state of the AST build, creates documentable and adds objects to the system.pydoctor.astutils.op_util
- This class provides data and functions for mapping AST nodes to symbols and precedences.pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser
- Parse google-style or numpy-style docstrings.pydoctor.epydoc.markup._pyval_repr._ColorizerState
- 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._MarkedColorizerState
- Undocumentedpydoctor.epydoc.markup._pyval_repr._OperatorDelimiter
- A context manager that can add enclosing delimiters to nested operators when needed.pydoctor.epydoc.markup._pyval_repr.PyvalColorizer
- Syntax highlighter for Python values.pydoctor.epydoc.markup.epytext.Element
- 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.Token
- 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.Field
- 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.restructuredtext._StrWriter
pydoctor.epydoc.markup.restructuredtext._DocumentPseudoWriter
- 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.sre_parse36.Pattern
- Undocumentedpydoctor.epydoc.sre_parse36.SubPattern
- Undocumentedpydoctor.epydoc.sre_parse36.Tokenizer
- Undocumentedpydoctor.epydoc2stan.Field
- Like pydoctor.epydoc.markup.Field
, but without the gross accessor methods and with a formatted body.pydoctor.epydoc2stan.FieldDesc
- Combines informations from multiple Field
objects into one.pydoctor.epydoc2stan._SignatureDesc
- Undocumentedpydoctor.epydoc2stan.KeywordDesc
- Undocumentedpydoctor.epydoc2stan.ParamDesc
- Undocumentedpydoctor.epydoc2stan.ReturnDesc
- Undocumentedpydoctor.epydoc2stan.RaisesDesc
- Description of an exception that can be raised by function/method.pydoctor.epydoc2stan.FieldHandler
- No class docstring; 0/13 instance variable, 3/22 methods, 0/1 static method documentedpydoctor.epydoc2stan.ParamType
- Undocumentedpydoctor.extensions.AttributeMixin
- Base class for mixins applied to model.Attribute
objects.pydoctor.extensions.DocumentableMixin
- Base class for mixins applied to all model.Documentable
objects.pydoctor.extensions.InheritableMixin
- Base class for mixins applied to model.Function
and model.Attribute
objects.pydoctor.extensions.zopeinterface.ZopeInterfaceAttribute
- Undocumentedpydoctor.extensions.ClassMixin
- Base class for mixins applied to model.Class
objects.pydoctor.extensions.attrs.AttrsClass
- No class docstring; 1/1 instance variable, 0/1 method documentedpydoctor.extensions.CanContainImportsDocumentableMixin
- Base class for mixins applied to model.Class
, model.Module
and model.Package
objects.pydoctor.extensions.DocumentableMixin
- Base class for mixins applied to all model.Documentable
objects.pydoctor.extensions.zopeinterface.ZopeInterfaceClass
- No class docstring; 1/1 property, 0/2 instance variable, 1/6 class variable, 0/1 method documentedpydoctor.extensions.ExtRegistrar
- The extension registrar class provides utilites to register an extension's components.pydoctor.extensions.FunctionMixin
- Base class for mixins applied to model.Function
objects.pydoctor.extensions.DocumentableMixin
- Base class for mixins applied to all model.Documentable
objects.pydoctor.extensions.InheritableMixin
- Base class for mixins applied to model.Function
and model.Attribute
objects.pydoctor.extensions.zopeinterface.ZopeInterfaceFunction
- Undocumentedpydoctor.extensions.ModuleMixin
- Base class for mixins applied to model.Module
objects.pydoctor.extensions.CanContainImportsDocumentableMixin
- Base class for mixins applied to model.Class
, model.Module
and model.Package
objects.pydoctor.extensions.DocumentableMixin
- Base class for mixins applied to all model.Documentable
objects.pydoctor.extensions.zopeinterface.ZopeInterfaceModule
- No class docstring; 1/1 property, 0/1 instance variable, 0/1 method documentedpydoctor.extensions.PackageMixin
- Base class for mixins applied to model.Package
objects.pydoctor.extensions.CanContainImportsDocumentableMixin
- Base class for mixins applied to model.Class
, model.Module
and model.Package
objects.pydoctor.extensions.PriorityProcessor
- 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.factory.GenericFactory
- No class docstring; 0/3 instance variable, 2/4 methods documentedpydoctor.factory.Factory
- Classes are created dynamically with `type` such that they can inherith from customizable mixin classes.pydoctor.model.Documentable
- An object that can be documented.pydoctor.model.CanContainImportsDocumentable
- Undocumentedpydoctor.model.Class
- No class docstring; 4/4 properties, 0/7 instance variable, 0/3 class variable, 4/6 methods documentedpydoctor.extensions.attrs.AttrsClass
- No class docstring; 1/1 instance variable, 0/1 method documentedpydoctor.extensions.zopeinterface.ZopeInterfaceClass
- No class docstring; 1/1 property, 0/2 instance variable, 1/6 class variable, 0/1 method documentedpydoctor.model.Module
- No class docstring; 1/3 property, 4/5 instance variables, 1/4 method documentedpydoctor.extensions.zopeinterface.ZopeInterfaceModule
- No class docstring; 1/1 property, 0/1 instance variable, 0/1 method documentedpydoctor.model.Package
- Undocumentedpydoctor.model.Inheritable
- Undocumentedpydoctor.model.Attribute
- No class docstring; 1/3 class variable documentedpydoctor.extensions.zopeinterface.ZopeInterfaceAttribute
- Undocumentedpydoctor.model.Function
- Undocumentedpydoctor.extensions.zopeinterface.ZopeInterfaceFunction
- Undocumentedpydoctor.model.FunctionOverload
- No summarypydoctor.model.System
- A collection of related documentable objects.pydoctor.mro.DependencyList
- 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.napoleon.docstring.Field
- 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.GoogleDocstring
- Convert Google style docstrings to reStructuredText.pydoctor.napoleon.docstring.NumpyDocstring
- Convert NumPy style docstrings to reStructuredText.pydoctor.napoleon.docstring.TypeDocstring
- Convert natural language type strings to reStructuredText.pydoctor.epydoc.markup._types.ParsedTypeDocstring
- Add ParsedDocstring
interface on top of TypeDocstring
and allow to parse types from nodes.Node
objects, providing the --process-types option.pydoctor.options.Options
- Container for all possible pydoctor options.pydoctor.sphinx._Unit
- A unit of time for maximum age parsing.pydoctor.sphinx.SphinxInventory
- Sphinx inventory handler.pydoctor.sphinx.SphinxInventoryWriter
- Sphinx inventory handler.pydoctor.templatewriter.search.LunrIndexWriter
- Class to write lunr indexes with configurable fields.pydoctor.templatewriter.TemplateLookup
- The TemplateLookup
handles the HTML template files locations. A little bit like mako.lookup.TemplateLookup but more simple.str
pydoctor.epydoc2stan.KeywordArgument
- Encapsulate the name of kwarg parameters in Function.annotations
mapping keys.pydoctor.epydoc2stan.VariableArgument
- Encapsulate the name of vararg parameters in Function.annotations
mapping keys.twisted.web.template.Element
pydoctor.templatewriter.pages.sidebar.LinkOnlyItem
- Sidebar leaf item: just a link to an object.pydoctor.templatewriter.pages.sidebar.ExpandableItem
- Sidebar expandable item: link to an object and have a triangle that expand/collapse it's contentspydoctor.templatewriter.pages.sidebar.ObjContent
- Object content displayed on the sidebar.pydoctor.templatewriter.pages.sidebar.SideBarSection
- Main sidebar section.pydoctor.templatewriter.pages.table.TableRow
- Undocumentedpydoctor.templatewriter.summary.LetterElement
- Undocumentedpydoctor.templatewriter.TemplateElement
- Renderable element based on a template file.pydoctor.templatewriter.pages.attributechild.AttributeChild
- Undocumentedpydoctor.templatewriter.pages.functionchild.FunctionChild
- Undocumentedpydoctor.templatewriter.pages.Head
- Common metadata.pydoctor.templatewriter.pages.Nav
- Common navigation header.pydoctor.templatewriter.pages.Page
- Abstract base class for output pages.pydoctor.templatewriter.pages.CommonPage
- No class docstring; 0/2 property, 0/3 instance variable, 0/1 class variable, 1/20 method documentedpydoctor.templatewriter.pages.ClassPage
- Undocumentedpydoctor.templatewriter.pages.ZopeInterfaceClassPage
- Undocumentedpydoctor.templatewriter.pages.ModulePage
- Undocumentedpydoctor.templatewriter.pages.PackagePage
- Undocumentedpydoctor.templatewriter.search.AllDocuments
- Undocumentedpydoctor.templatewriter.summary.ClassIndexPage
- Undocumentedpydoctor.templatewriter.summary.IndexPage
- Undocumentedpydoctor.templatewriter.summary.ModuleIndexPage
- Undocumentedpydoctor.templatewriter.summary.NameIndexPage
- Undocumentedpydoctor.templatewriter.summary.UndocumentedSummaryPage
- Undocumentedpydoctor.templatewriter.pages.sidebar.ContentList
- List of child objects that share the same type.pydoctor.templatewriter.pages.table.ChildTable
- Undocumentedtype
pydoctor.astutils._StrMeta
- Undocumentedtyping.Generic
pydoctor.napoleon.iterators.peek_iter
- An iterator object that supports peeking ahead.pydoctor.napoleon.iterators.modify_iter
- An iterator object that supports modifying items as they are returned.pydoctor.templatewriter.util.CaseInsensitiveDict
- 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.visitor._BaseVisitor
- No class docstring; 4/4 methods documentedpydoctor.visitor.Visitor
- "Visitor" pattern abstract superclass implementation for tree traversals.pydoctor.visitor.PartialVisitor
- 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.astutils.NodeVisitor
- 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.astbuilder.ModuleVistor
- No class docstring; 0/4 instance variable, 9/39 methods, 0/3 static method, 0/1 class method documentedpydoctor.visitor.VisitorExt
- The node visitor extension base class, to inherit from.pydoctor.astutils.NodeVisitorExt
- Undocumentedpydoctor.extensions.ModuleVisitorExt
- Base class to extend the astbuilder.ModuleVistor
.pydoctor.astbuilder.TypeAliasVisitorExt
- This visitor implements the handling of type aliases and type variables.pydoctor.extensions.attrs.ModuleVisitor
- No class docstring; 1/4 method documentedpydoctor.extensions.deprecate.ModuleVisitor
- No class docstring; 2/2 methods documentedpydoctor.extensions.zopeinterface.ZopeInterfaceModuleVisitor
- Undocumentedpydoctor.visitor.ExtList
- This class helps iterating on visitor extensions that should run at different times.typing.MutableMapping
pydoctor.templatewriter.util.CaseInsensitiveDict
- 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...typing.Protocol
pydoctor.epydoc.markup.DocstringLinker
- A resolver for crossreference links out of a ParsedDocstring. DocstringLinker is used by ParsedDocstring to look up the target URL for crossreference links.pydoctor.linker._AnnotationLinker
- Specialized linker to resolve annotations attached to the given Documentable
.pydoctor.linker._EpydocLinker
- This linker implements the xref lookup logic.typing_extensions.Protocol
pydoctor.sphinx.CacheT
- Undocumentedpydoctor.sphinx.IntersphinxCache
- An Intersphinx cache.pydoctor.templatewriter.IWriter
- Interface class for pydoctor output writer.pydoctor.templatewriter.TemplateWriter
- HTML templates writer.