abc.ABC
pydoctor.epydoc.markup.ParsedDocstring
- No summarypydoctor.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.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
- Undocumentedpydoctor.templatewriter.pages.ClassPage
- Undocumentedpydoctor.templatewriter.pages.ZopeInterfaceClassPage
- Undocumentedpydoctor.templatewriter.pages.ModulePage
- Undocumentedpydoctor.templatewriter.pages.PackagePage
- Undocumentedpydoctor.templatewriter.summary.ClassIndexPage
- Undocumentedpydoctor.templatewriter.summary.IndexPage
- Undocumentedpydoctor.templatewriter.summary.ModuleIndexPage
- Undocumentedpydoctor.templatewriter.summary.NameIndexPage
- Undocumentedpydoctor.templatewriter.summary.UndocumentedSummaryPage
- Undocumentedpydoctor.templatewriter.pages.table.ChildTable
- Undocumentedast.NodeTransformer
pydoctor.astbuilder._AnnotationStringParser
- Implementation of ModuleVistor._unstring_annotation()
.pydoctor.epydoc.markup._pyval_repr._Parentage
- Add parent attribute to ast nodes instances.ast.NodeVisitor
pydoctor.astbuilder.ModuleVistor
- No class docstring; 0/5 instance variable, 7/29 methods documentedpydoctor.zopeinterface.ZopeInterfaceModuleVisitor
- Undocumenteddocutils.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 fieldsdocutils.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
- No summarypydoctor.epydoc.markup.restructuredtext.VersionChange
- Directive to describe a change/addition/deprecation in a specific version.pydoctor.sphinx_ext._help_output.HelpOutputDirective
- Directive that will generate the pydoctor help as block literal.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.docutils.writers.Writer
enum.Enum
pydoctor.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
- UndocumentedException
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_parse36.Verbose
- Undocumentedpydoctor.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 pydoctorGeneric[_VT]
pydoctor.templatewriter.util.CaseInsensitiveDict
- No summaryGeneric[T]
pydoctor.napoleon.iterators.peek_iter
- An iterator object that supports peeking ahead.io.BytesIO
pydoctor.test.test_sphinx.ClosingBytesIO
- A io.BytesIO
instance that closes itself after all its data has been read. This mimics the behavior of http.client.HTTPResponse
in the standard library.MutableMapping[str, _VT]
pydoctor.templatewriter.util.CaseInsensitiveDict
- No summaryoptparse.Option
pydoctor.driver.CustomOption
- Undocumentedpeek_iter[T]
pydoctor.napoleon.iterators.modify_iter
- An iterator object that supports modifying items as they are returned.pydoctor.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.ASTBuilder
- Undocumentedpydoctor.zopeinterface.ZopeInterfaceASTBuilder
- Undocumentedpydoctor.epydoc.markup._napoleon.NapoelonDocstringParser
- Parse google-style or numpy-style docstrings.pydoctor.epydoc.markup._pyval_repr._ColorizerState
- No summarypydoctor.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.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.epydoc2stan._EpydocLinker
- No class docstring; 0/1 instance variable, 2/7 methods documentedpydoctor.test.NotFoundLinker
- A DocstringLinker implementation that cannot find any links.pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker
- A DocstringLinker implementation that cannot find any links, but does record which identifiers it was asked to link.pydoctor.epydoc.markup.epytext.Element
- No summarypydoctor.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
- No summarypydoctor.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.RaisesDesc
- Description of an exception that can be raised by function/method.pydoctor.epydoc2stan.FieldHandler
- No class docstring; 0/13 instance variable, 2/22 methods, 0/1 static method documentedpydoctor.model.Documentable
- An object that can be documented.pydoctor.model.CanContainImportsDocumentable
- Undocumentedpydoctor.model.Class
- No class docstring; 1/1 property, 0/2 instance variable, 1/6 class variable, 1/4 method documentedpydoctor.zopeinterface.ZopeInterfaceClass
- No class docstring; 1/1 property, 0/1 instance variable, 1/7 class variable, 0/1 method documentedpydoctor.model.Module
- No class docstring; 1/3 property, 1/2 instance variable, 0/3 method documentedpydoctor.model.Package
- Undocumentedpydoctor.zopeinterface.ZopeInterfaceModule
- No class docstring; 1/1 property, 0/1 instance variable, 0/1 method documentedpydoctor.model.Inheritable
- Undocumentedpydoctor.model.Attribute
- No class docstring; 1/3 class variable documentedpydoctor.zopeinterface.ZopeInterfaceAttribute
- Undocumentedpydoctor.model.Function
- Undocumentedpydoctor.zopeinterface.ZopeInterfaceFunction
- Undocumentedpydoctor.test.test_sphinx.UnknownType
- Documentable type to help with testing.pydoctor.model.System
- A collection of related documentable objects.pydoctor.zopeinterface.ZopeInterfaceSystem
- Undocumentedpydoctor.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.sphinx._Unit
- A unit of time for maximum age parsing.pydoctor.sphinx.SphinxInventory
- Sphinx inventory handler.pydoctor.test.test_sphinx.InvReader
- Undocumentedpydoctor.sphinx.SphinxInventoryWriter
- Sphinx inventory handler.pydoctor.test.test_sphinx.InvWriter
- Undocumentedpydoctor.templatewriter.pages.DocGetter
- epydoc2stan
bridge.pydoctor.templatewriter.TemplateLookup
- The TemplateLookup
handles the HTML template files locations. A little bit like mako.lookup.TemplateLookup but more simple.pydoctor.test.test_epydoc2stan.InMemoryInventory
- A simple inventory implementation which has an in-memory API link mapping.pydoctor.test.test_model.Dummy
- No class docstring; 1/1 method documentedpydoctor.test.test_model.FakeDocumentable
- A fake of pydoctor.model.Documentable that provides a system and sourceHref attribute.pydoctor.test.test_model.FakeOptions
- A fake options object as if it came from that stupid optparse thing.pydoctor.test.test_sphinx.PydoctorLogger
- Partial implementation of pydoctor.model.System.msg() that records logged messages.pydoctor.test.test_sphinx.PydoctorNoLogger
- Partial implementation of pydoctor.model.System.msg() that asserts if any message is logged.pydoctor.test.test_sphinx.TestIntersphinxCache
- Tests for sphinx.IntersphinxCache
pydoctor.test.test_sphinx.TestParseMaxAge
- Tests for sphinx.parseMaxAge
pydoctor.test.test_utils.TestCaseInsensitiveDict
- No class docstring; 0/1 instance variable, 0/1 class variable, 1/8 method documentedstr
pydoctor.epydoc2stan.KeywordArgument
- Encapsulate the name of kwarg parameters.pydoctor.epydoc2stan.VariableArgument
- Encapsulate the name of vararg parameters.twisted.web.template.Element
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
- Undocumentedpydoctor.templatewriter.pages.ClassPage
- Undocumentedpydoctor.templatewriter.pages.ZopeInterfaceClassPage
- Undocumentedpydoctor.templatewriter.pages.ModulePage
- Undocumentedpydoctor.templatewriter.pages.PackagePage
- Undocumentedpydoctor.templatewriter.summary.ClassIndexPage
- Undocumentedpydoctor.templatewriter.summary.IndexPage
- Undocumentedpydoctor.templatewriter.summary.ModuleIndexPage
- Undocumentedpydoctor.templatewriter.summary.NameIndexPage
- Undocumentedpydoctor.templatewriter.summary.UndocumentedSummaryPage
- Undocumentedpydoctor.templatewriter.pages.table.ChildTable
- Undocumentedtyping_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.pydoctor.test.InMemoryWriter
- Minimal template writer that doesn't touches the filesystem but will trigger the rendering of epydoc for the targeted code.pydoctor.test.CapLog
- Undocumentedpydoctor.test.CapSys
- Undocumentedpydoctor.test.CaptureResult
- Undocumentedunittest.TestCase
pydoctor.test.epydoc.test_google_numpy.TestGetParser
- Undocumentedpydoctor.test.epydoc.test_google_numpy.TestWarnings
- Undocumentedpydoctor.test.test_napoleon_docstring.BaseDocstringTest
- No class docstring; 0/1 class variable, 1/1 method documentedpydoctor.test.test_napoleon_docstring.GoogleDocstringTest
- Undocumentedpydoctor.test.test_napoleon_docstring.InlineAttributeTest
- Undocumentedpydoctor.test.test_napoleon_docstring.NumpyDocstringTest
- No class docstring; 0/3 class variable, 2/24 methods documentedpydoctor.test.test_napoleon_docstring.TypeDocstringTest
- Undocumentedpydoctor.test.test_napoleon_iterators.BaseIteratorsTest
- Undocumentedpydoctor.test.test_napoleon_iterators.ModifyIterTest
- Undocumentedpydoctor.test.test_napoleon_iterators.PeekIterTest
- Undocumented