Class Hierarchy

abc.ABC
- sphinx.domains.Index - An Index is the description for a domain-specific index. To add an index to a domain, subclass Index, overriding the three name attributes:
  - sphinx.domains.python.PythonModuleIndex - Index subclass to provide the Python module index.
ast.NodeVisitor
- sphinx.pycode.ast._UnparseVisitor - No class docstring; 0/1 instance variable, 1/25 method documented
collections.UserString
- sphinx.locale._TranslationProxy - Class for proxy strings from gettext translations. This is a helper for the lazy_* functions from this module.
datetime.tzinfo
- sphinx.builders.gettext.LocalTimeZone - Undocumented
DeprecationWarning
- sphinx.deprecation.RemovedInSphinx50Warning - Undocumented
dict
- sphinx.deprecation.DeprecatedDict - A deprecated dict which warns on each access.
- sphinx.ext.autodoc.directive.DummyOptionSpec - An option_spec allows any options.
- sphinx.ext.autodoc.Options - A dict/attribute hybrid that returns None on nonexisting keys.
- sphinx.util.DownloadFiles - A special dictionary for download files.
- sphinx.util.FilenameUniqDict - A dictionary that automatically generates unique names for its keys, interpreted as filenames, and keeps track of a set of docnames they appear in. Used for images and downloadable files in the environment.
Dict[str, Any]
- sphinx.util.inspect.TypeAliasNamespace - Pseudo namespace class for autodoc_type_aliases.
distutils.cmd.Command
- sphinx.setup_command.BuildDoc - Distutils command to build Sphinx documentation.
doctest.DocTestRunner
- sphinx.ext.doctest.SphinxDocTestRunner - Undocumented
docutils.io.FileInput
- sphinx.io.SphinxFileInput - A basic FileInput for Sphinx.
docutils.io.FileOutput
- sphinx.util.docutils.SphinxFileOutput - Better FileOutput class for Sphinx.
docutils.nodes.Admonition
- sphinx.addnodes.desc - Node for a list of object signatures and a common description of them.
- sphinx.addnodes.productionlist - Node for grammar production lists.
- sphinx.addnodes.seealso - Custom "see also" admonition.
- sphinx.addnodes.versionmodified - Node for version change entries.
- sphinx.ext.todo.todo_node - Undocumented
docutils.nodes.BackLinkable
- sphinx.builders.latex.nodes.footnotetext - A node represents `` ootnotetext``.
docutils.nodes.comment
- sphinx.ext.autosummary.autosummary_table - Undocumented
- sphinx.ext.autosummary.autosummary_toc - Undocumented
docutils.nodes.container
- sphinx.builders.latex.nodes.captioned_literal_block - A node for a container of literal_block having a caption.
- sphinx.builders.latex.nodes.thebibliography - A node for wrapping bibliographies.
docutils.nodes.document
- sphinx.addnodes.document - The document root element patched by Sphinx.
docutils.nodes.Element
- sphinx.addnodes._desc_classes_injector - Helper base class for injecting a fixes list of classes.
  - sphinx.addnodes.desc_addname - Node for additional name parts for an object.
  - sphinx.addnodes.desc_inline - Node for a signature fragment in inline text.
  - sphinx.addnodes.desc_name - Node for the main object name.
  - sphinx.addnodes.desc_sig_element - Common parent class of nodes for inline text of a signature.
    - sphinx.addnodes.desc_sig_keyword - Node for a general keyword in a signature.
    - sphinx.addnodes.desc_sig_keyword_type - Node for a keyword which is a built-in type in a signature.
    - sphinx.addnodes.desc_sig_literal_char - Node for a character literal in a signature.
    - sphinx.addnodes.desc_sig_literal_number - Node for a numeric literal in a signature.
    - sphinx.addnodes.desc_sig_literal_string - Node for a string literal in a signature.
    - sphinx.addnodes.desc_sig_name - Node for an identifier in a signature.
    - sphinx.addnodes.desc_sig_operator - Node for an operator in a signature.
    - sphinx.addnodes.desc_sig_punctuation - Node for punctuation in a signature.
    - sphinx.addnodes.desc_sig_space - Node for a space in a signature.
  - sphinx.addnodes.desc_signature - Node for a single object signature.
- sphinx.addnodes.acks - Special node for "acks" lists.
- sphinx.addnodes.desc - Node for a list of object signatures and a common description of them.
- sphinx.addnodes.desc_content - Node for object description content.
- sphinx.addnodes.glossary - Node to insert a glossary.
- sphinx.addnodes.highlightlang - Inserted to set the highlight language and line number options for subsequent code blocks.
- sphinx.addnodes.hlist - Node for "horizontal lists", i.e. lists that should be compressed to take up less vertical space.
- sphinx.addnodes.hlistcol - Node for one column in a horizontal list.
- sphinx.addnodes.meta - Node for meta directive -- same as docutils' standard meta node, but pickleable.
- sphinx.addnodes.only - Node for "only" directives (conditional inclusion based on tags).
- sphinx.addnodes.pending_xref - Node for cross-references that cannot be resolved without complete information about all documents.
- sphinx.addnodes.productionlist - Node for grammar production lists.
- sphinx.addnodes.seealso - Custom "see also" admonition.
- sphinx.addnodes.start_of_file - Node to mark start of a new file, used in the LaTeX builder only.
- sphinx.addnodes.tabular_col_spec - Node for specifying tabular columns, used for LaTeX output.
- sphinx.addnodes.toctree - Node for inserting a "TOC tree".
- sphinx.builders.latex.nodes.footnotetext - A node represents `` ootnotetext``.
- sphinx.domains.c.AliasNode - Undocumented
- sphinx.domains.cpp.AliasNode - Undocumented
- sphinx.ext.graphviz.graphviz - Undocumented
  - sphinx.ext.inheritance_diagram.inheritance_diagram - A docutils node to use as a placeholder for the inheritance diagram.
- sphinx.ext.ifconfig.ifconfig - Undocumented
- sphinx.ext.todo.todo_node - Undocumented
- sphinx.ext.todo.todolist - Undocumented
- sphinx.ext.viewcode.viewcode_anchor - Node for viewcode anchors.
docutils.nodes.emphasis
- sphinx.addnodes.literal_emphasis - Node that behaves like emphasis, but further text processors are not applied (e.g. smartypants for HTML output).
docutils.nodes.FixedTextElement
- sphinx.addnodes.desc_addname - Node for additional name parts for an object.
- sphinx.addnodes.desc_annotation - Node for signature annotations (not Python 3-style annotations).
- sphinx.addnodes.desc_name - Node for the main object name.
- sphinx.addnodes.desc_optional - Node for marking optional parts of the parameter list.
- sphinx.addnodes.desc_parameter - Node for a single parameter.
- sphinx.addnodes.desc_parameterlist - Node for a general parameter list.
- sphinx.addnodes.desc_signature_line - Node for a line in a multi-line object signature.
- sphinx.addnodes.desc_type - Node for return types or object type names.
  - sphinx.addnodes.desc_returns - Node for a "returns" annotation (a la -> in Python).
- sphinx.addnodes.manpage - Node for references to manpages.
- sphinx.addnodes.production - Node for a single grammar production rule.
docutils.nodes.footnote
- sphinx.writers.latex.collected_footnote - Footnotes that are collected are assigned this class.
docutils.nodes.General
- sphinx.addnodes.desc_content - Node for object description content.
- sphinx.addnodes.toctree - Node for inserting a "TOC tree".
- sphinx.builders.latex.nodes.footnotetext - A node represents `` ootnotetext``.
- sphinx.ext.graphviz.graphviz - Undocumented
  - sphinx.ext.inheritance_diagram.inheritance_diagram - A docutils node to use as a placeholder for the inheritance diagram.
- sphinx.ext.todo.todolist - Undocumented
docutils.nodes.GenericNodeVisitor
- sphinx.transforms.compact_bullet_list.RefOnlyListChecker - Raise nodes.NodeFound if non-simple list item is encountered.
docutils.nodes.Inline
- sphinx.addnodes.desc_addname - Node for additional name parts for an object.
- sphinx.addnodes.desc_annotation - Node for signature annotations (not Python 3-style annotations).
- sphinx.addnodes.desc_inline - Node for a signature fragment in inline text.
- sphinx.addnodes.desc_name - Node for the main object name.
- sphinx.addnodes.desc_optional - Node for marking optional parts of the parameter list.
- sphinx.addnodes.desc_parameter - Node for a single parameter.
- sphinx.addnodes.desc_parameterlist - Node for a general parameter list.
- sphinx.addnodes.desc_signature - Node for a single object signature.
- sphinx.addnodes.desc_signature_line - Node for a line in a multi-line object signature.
- sphinx.addnodes.desc_type - Node for return types or object type names.
  - sphinx.addnodes.desc_returns - Node for a "returns" annotation (a la -> in Python).
- sphinx.addnodes.index - Node for index entries.
- sphinx.addnodes.manpage - Node for references to manpages.
- sphinx.addnodes.pending_xref - Node for cross-references that cannot be resolved without complete information about all documents.
- sphinx.addnodes.pending_xref_condition - Node for cross-references that are used to choose appropriate content of the reference by conditions on the resolving phase.
- sphinx.addnodes.production - Node for a single grammar production rule.
- sphinx.builders.latex.nodes.footnotemark - A node represents `` ootnotemark``.
- sphinx.builders.latex.nodes.math_reference - A node for a reference for equation.
- sphinx.ext.graphviz.graphviz - Undocumented
  - sphinx.ext.inheritance_diagram.inheritance_diagram - A docutils node to use as a placeholder for the inheritance diagram.
docutils.nodes.inline
- sphinx.addnodes.desc_sig_element - Common parent class of nodes for inline text of a signature.
  - sphinx.addnodes.desc_sig_keyword - Node for a general keyword in a signature.
  - sphinx.addnodes.desc_sig_keyword_type - Node for a keyword which is a built-in type in a signature.
  - sphinx.addnodes.desc_sig_literal_char - Node for a character literal in a signature.
  - sphinx.addnodes.desc_sig_literal_number - Node for a numeric literal in a signature.
  - sphinx.addnodes.desc_sig_literal_string - Node for a string literal in a signature.
  - sphinx.addnodes.desc_sig_name - Node for an identifier in a signature.
  - sphinx.addnodes.desc_sig_operator - Node for an operator in a signature.
  - sphinx.addnodes.desc_sig_punctuation - Node for punctuation in a signature.
  - sphinx.addnodes.desc_sig_space - Node for a space in a signature.
docutils.nodes.Invisible
- sphinx.addnodes.index - Node for index entries.
docutils.nodes.Labeled
- sphinx.builders.latex.nodes.footnotetext - A node represents `` ootnotetext``.
docutils.nodes.Node
- sphinx.addnodes.translatable - Node which supports translation.
  - sphinx.addnodes.toctree - Node for inserting a "TOC tree".
docutils.nodes.NodeVisitor
- sphinx.builders.latex.transforms.FootnoteCollector - Collect footnotes and footnote references on the document
- sphinx.builders.latex.transforms.LaTeXFootnoteVisitor - Undocumented
- sphinx.search.WordCollector - A special visitor that collects words for the IndexBuilder.
- sphinx.transforms.post_transforms.code.HighlightLanguageVisitor - Undocumented
- sphinx.util.docutils.SphinxTranslator - A base class for Sphinx translators.
  - sphinx.writers.html.HTMLTranslator - Our custom HTML translator.
  - sphinx.writers.html5.HTML5Translator - Our custom HTML translator.
  - sphinx.writers.latex.LaTeXTranslator - No class docstring; 1/1 property, 0/32 instance variable, 0/4 class variable, 3/223 methods documented
  - sphinx.writers.manpage.ManualPageTranslator - Custom man page translator.
  - sphinx.writers.texinfo.TexinfoTranslator - No class docstring; 0/1 property, 0/31 instance variable, 0/5 class variable, 9/222 methods documented
  - sphinx.writers.text.TextTranslator - Undocumented
docutils.nodes.paragraph
- sphinx.addnodes.compact_paragraph - Node for a compact paragraph (which never makes a <p> node).
docutils.nodes.Part
- sphinx.addnodes.centered - Deprecated.
- sphinx.addnodes.desc_addname - Node for additional name parts for an object.
- sphinx.addnodes.desc_annotation - Node for signature annotations (not Python 3-style annotations).
- sphinx.addnodes.desc_name - Node for the main object name.
- sphinx.addnodes.desc_optional - Node for marking optional parts of the parameter list.
- sphinx.addnodes.desc_parameter - Node for a single parameter.
- sphinx.addnodes.desc_parameterlist - Node for a general parameter list.
- sphinx.addnodes.desc_signature - Node for a single object signature.
- sphinx.addnodes.desc_signature_line - Node for a line in a multi-line object signature.
- sphinx.addnodes.desc_type - Node for return types or object type names.
  - sphinx.addnodes.desc_returns - Node for a "returns" annotation (a la -> in Python).
- sphinx.addnodes.production - Node for a single grammar production rule.
docutils.nodes.PreBibliographic
- sphinx.addnodes.meta - Node for meta directive -- same as docutils' standard meta node, but pickleable.
docutils.nodes.reference
- sphinx.addnodes.download_reference - Node for download references, similar to pending_xref.
- sphinx.addnodes.number_reference - Node for number references, similar to pending_xref.
docutils.nodes.Referential
- sphinx.builders.latex.nodes.footnotemark - A node represents `` ootnotemark``.
- sphinx.builders.latex.nodes.math_reference - A node for a reference for equation.
docutils.nodes.Special
- sphinx.addnodes.meta - Node for meta directive -- same as docutils' standard meta node, but pickleable.
docutils.nodes.strong
- sphinx.addnodes.literal_strong - Node that behaves like strong, but further text processors are not applied (e.g. smartypants for HTML output).
docutils.nodes.Targetable
- sphinx.builders.latex.nodes.footnotetext - A node represents `` ootnotetext``.
docutils.nodes.TextElement
- sphinx.addnodes.centered - Deprecated.
- sphinx.addnodes.desc_inline - Node for a signature fragment in inline text.
- sphinx.addnodes.desc_signature - Node for a single object signature.
- sphinx.addnodes.index - Node for index entries.
- sphinx.addnodes.pending_xref_condition - Node for cross-references that are used to choose appropriate content of the reference by conditions on the resolving phase.
- sphinx.addnodes.versionmodified - Node for version change entries.
- sphinx.builders.latex.nodes.footnotemark - A node represents `` ootnotemark``.
- sphinx.builders.latex.nodes.math_reference - A node for a reference for equation.
docutils.parsers.Parser
- sphinx.parsers.Parser - A base class of source parsers. The additional parsers should inherit this class instead of docutils.parsers.Parser. Compared with docutils.parsers.Parser, this class improves accessibility to Sphinx APIs.
  - sphinx.parsers.RSTParser - A reST parser for Sphinx.
docutils.parsers.rst.Directive
- sphinx.util.docutils.SphinxDirective - A base class for Sphinx directives.
  - sphinx.directives.code.CodeBlock - Directive for a code block with special highlighting or line numbering settings.
  - sphinx.directives.code.Highlight - Directive to set the highlighting language for code blocks, as well as the threshold for line numbers.
  - sphinx.directives.code.LiteralInclude - Like .. include:: :literal:, but only warns if the include file is not found, and does not raise errors. Also has several options for selecting what to include.
  - sphinx.directives.DefaultDomain - Directive to (re-)set the default domain for this source file.
  - sphinx.directives.DefaultRole - Set the default interpreted text role. Overridden from docutils.
  - sphinx.directives.ObjectDescription - Directive to describe a class, function or similar object. Not used directly, but subclassed (in domain-specific directives) to add custom behavior.
    - sphinx.domains.c.CAliasObject - No class docstring; 0/3 instance variable, 0/1 class variable, 1/1 method documented
    - sphinx.domains.cpp.CPPAliasObject - No class docstring; 0/3 instance variable, 0/1 class variable, 1/1 method documented
  - sphinx.directives.other.Acks - Directive for a list of names.
  - sphinx.directives.other.Author - Directive to give the name of the author of the current document or section. Shown in the output only if the show_authors option is on.
  - sphinx.directives.other.Centered - Directive to create a centered line of bold text.
  - sphinx.directives.other.HList - Directive for a list that gets compacted horizontally.
  - sphinx.directives.other.Include - Like the standard "Include" directive, but interprets absolute paths "correctly", i.e. relative to source directory.
  - sphinx.directives.other.Only - Directive to only include text if the given tag(s) are enabled.
  - sphinx.directives.other.TabularColumns - Directive to give an explicit tabulary column definition to LaTeX.
  - sphinx.directives.other.TocTree - Directive to notify Sphinx about the hierarchical structure of the docs, and to include a table-of-contents like tree in the current document.
  - sphinx.directives.patches.Code - Parse and mark up content of a code block.
  - sphinx.directives.patches.MathDirective - Undocumented
  - sphinx.directives.patches.Meta - Undocumented
  - sphinx.domains.c.CNamespaceObject - This directive is just to tell Sphinx that we're documenting stuff in namespace foo.
  - sphinx.domains.c.CNamespacePopObject - Undocumented
  - sphinx.domains.c.CNamespacePushObject - Undocumented
  - sphinx.domains.changeset.VersionChange - Directive to describe a change/addition/deprecation in a specific version.
  - sphinx.domains.cpp.CPPNamespaceObject - This directive is just to tell Sphinx that we're documenting stuff in namespace foo.
  - sphinx.domains.cpp.CPPNamespacePopObject - Undocumented
  - sphinx.domains.cpp.CPPNamespacePushObject - Undocumented
  - sphinx.domains.index.IndexDirective - Directive to add entries to the index.
  - sphinx.domains.javascript.JSModule - Directive to mark description of a new JavaScript module.
  - sphinx.domains.python.PyCurrentModule - This directive is just to tell Sphinx that we're documenting stuff in module foo, but links to module foo won't lead here.
  - sphinx.domains.python.PyModule - Directive to mark description of a new module.
  - sphinx.domains.std.Glossary - Directive to create a glossary with cross-reference targets for :term: roles.
  - sphinx.domains.std.ProductionList - Directive to list grammar productions.
  - sphinx.domains.std.Program - Directive to name the program for which options are documented.
  - sphinx.domains.std.Target - Generic target for user-defined cross-reference types.
  - sphinx.ext.autodoc.directive.AutodocDirective - A directive class for all autodoc directives. It works as a dispatcher of Documenters.
  - sphinx.ext.autosummary.Autosummary - Pretty table containing short signatures and summaries of functions etc.
  - sphinx.ext.doctest.TestDirective - Base class for doctest-related directives.
    - sphinx.ext.doctest.DoctestDirective - Undocumented
    - sphinx.ext.doctest.TestcleanupDirective - Undocumented
    - sphinx.ext.doctest.TestcodeDirective - Undocumented
    - sphinx.ext.doctest.TestoutputDirective - Undocumented
    - sphinx.ext.doctest.TestsetupDirective - Undocumented
  - sphinx.ext.graphviz.Graphviz - Directive to insert arbitrary dot markup.
  - sphinx.ext.graphviz.GraphvizSimple - Directive to insert arbitrary dot markup.
  - sphinx.ext.ifconfig.IfConfig - Undocumented
  - sphinx.ext.inheritance_diagram.InheritanceDiagram - Run when the inheritance_diagram directive is first encountered.
  - sphinx.ext.todo.Todo - A todo entry, displayed (if configured) in the form of an admonition.
  - sphinx.ext.todo.TodoList - A list of all todo entries.
docutils.parsers.rst.directives.admonitions.BaseAdmonition
- sphinx.directives.other.SeeAlso - An admonition mentioning things to look at as reference.
- sphinx.ext.todo.Todo - A todo entry, displayed (if configured) in the form of an admonition.
docutils.parsers.rst.directives.html.Meta
- sphinx.directives.patches.Meta - Undocumented
docutils.parsers.rst.directives.images.Figure
- sphinx.directives.patches.Figure - The figure directive which applies :name: option to the figure node instead of the image node.
docutils.parsers.rst.directives.misc.Include
- sphinx.directives.other.Include - Like the standard "Include" directive, but interprets absolute paths "correctly", i.e. relative to source directory.
docutils.parsers.rst.directives.tables.CSVTable
- sphinx.directives.patches.CSVTable - The csv-table directive which searches a CSV file from Sphinx project's source directory when an absolute path is given via :file: option.
docutils.parsers.rst.directives.tables.ListTable
- sphinx.directives.patches.ListTable - The list-table directive which sets source and line information to its caption.
docutils.parsers.rst.directives.tables.RSTTable
- sphinx.directives.patches.RSTTable - The table directive which sets source and line information to its caption.
docutils.parsers.rst.Parser
- sphinx.parsers.RSTParser - A reST parser for Sphinx.
docutils.readers.standalone.Reader
- sphinx.io.SphinxBaseReader - A base class of readers for Sphinx.
  - sphinx.io.SphinxI18nReader - A document reader for i18n.
  - sphinx.io.SphinxStandaloneReader - A basic document reader for Sphinx.
docutils.transforms.parts.ContentsFilter
- sphinx.transforms.SphinxContentsFilter - Used with BuildEnvironment.add_toc_from() to discard cross-file links within table-of-contents link nodes.
docutils.transforms.references.DanglingReferences
- sphinx.transforms.references.SphinxDanglingReferences - DanglingReferences transform which does not output info messages.
docutils.transforms.Transform
- sphinx.transforms.SphinxTransform - A base class of Transforms.
  - sphinx.builders.latex.transforms.FootnoteDocnameUpdater - Add docname to footnote and footnote_reference nodes.
  - sphinx.domains.c.AliasTransform - Undocumented
  - sphinx.domains.citation.CitationDefinitionTransform - Mark citation definition labels as not smartquoted.
  - sphinx.domains.citation.CitationReferenceTransform - Replace citation references by pending_xref nodes before the default docutils transform tries to resolve them.
  - sphinx.domains.cpp.AliasTransform - Undocumented
  - sphinx.transforms.ApplySourceWorkaround - Update source and rawsource attributes
  - sphinx.transforms.AutoIndexUpgrader - Detect old style (4 column based indices) and automatically upgrade to new style.
  - sphinx.transforms.AutoNumbering - Register IDs of tables, figures and literal_blocks to assign numbers.
  - sphinx.transforms.compact_bullet_list.RefOnlyBulletListTransform - Change refonly bullet lists to use compact_paragraphs.
  - sphinx.transforms.DefaultSubstitutions - Replace some substitutions if they aren't defined in the document.
  - sphinx.transforms.DoctestTransform - Set "doctest" style to each doctest_block node
  - sphinx.transforms.DoctreeReadEvent - Emit :event:`doctree-read` event.
  - sphinx.transforms.ExtraTranslatableNodes - Make nodes translatable
  - sphinx.transforms.FigureAligner - Align figures to center by default.
  - sphinx.transforms.FilterSystemMessages - Filter system messages from a doctree.
  - sphinx.transforms.GlossarySorter - Sort glossaries that have the sorted flag.
  - sphinx.transforms.HandleCodeBlocks - Several code block related transformations.
  - sphinx.transforms.i18n.Locale - Replace translatable nodes with their translated doctree.
  - sphinx.transforms.i18n.PreserveTranslatableMessages - Preserve original translatable messages before translation
  - sphinx.transforms.i18n.RemoveTranslatableInline - Remove inline nodes used for translation as placeholders.
  - sphinx.transforms.ManpageLink - Find manpage section numbers and names
  - sphinx.transforms.MoveModuleTargets - Move module targets that are the first thing in a section to the section title.
  - sphinx.transforms.post_transforms.code.HighlightLanguageTransform - Apply highlight_language to all literal_block nodes.
  - sphinx.transforms.post_transforms.code.TrimDoctestFlagsTransform - Trim doctest flags like # doctest: +FLAG from python code-blocks.
  - sphinx.transforms.post_transforms.images.BaseImageConverter - Undocumented
    - sphinx.transforms.post_transforms.images.DataURIExtractor - Undocumented
    - sphinx.transforms.post_transforms.images.ImageConverter - A base class for image converters.
      - sphinx.ext.imgconverter.ImagemagickConverter - No class docstring; 0/1 class variable, 2/2 methods documented
    - sphinx.transforms.post_transforms.images.ImageDownloader - Undocumented
  - sphinx.transforms.post_transforms.SphinxPostTransform - A base class of post-transforms.
    - sphinx.builders.html.transforms.KeyboardTransform - Transform :kbd: role to more detailed form.
    - sphinx.builders.latex.transforms.BibliographyTransform - Gather bibliography entries to tail of document.
    - sphinx.builders.latex.transforms.CitationReferenceTransform - Replace pending_xref nodes for citation by citation_reference.
    - sphinx.builders.latex.transforms.DocumentTargetTransform - Add :doc label to the first section of each document.
    - sphinx.builders.latex.transforms.IndexInSectionTitleTransform - Move index nodes in section title to outside of the title.
    - sphinx.builders.latex.transforms.LaTeXFootnoteTransform - Convert footnote definitions and references to appropriate form to LaTeX.
    - sphinx.builders.latex.transforms.LiteralBlockTransform - Replace container nodes for literal_block by captioned_literal_block.
    - sphinx.builders.latex.transforms.MathReferenceTransform - Replace pending_xref nodes for math by math_reference.
    - sphinx.builders.latex.transforms.ShowUrlsTransform - Expand references to inline text or footnotes.
    - sphinx.builders.latex.transforms.SubstitutionDefinitionsRemover - Remove ``substitution_definition node from doctrees.
    - sphinx.builders.linkcheck.HyperlinkCollector - Undocumented
    - sphinx.ext.extlinks.ExternalLinksChecker - For each external link, check if it can be replaced by an extlink.
    - sphinx.ext.viewcode.ViewcodeAnchorTransform - Convert or remove viewcode_anchor nodes depends on builder.
    - sphinx.transforms.post_transforms.OnlyNodeTransform - Undocumented
    - sphinx.transforms.post_transforms.PropagateDescDomain - Add the domain name of the parent node as a class in each desc_signature node.
    - sphinx.transforms.post_transforms.ReferencesResolver - Resolves cross-references on doctrees.
      - sphinx.ext.intersphinx.IntersphinxRoleResolver - pending_xref node resolver for intersphinx role.
    - sphinx.transforms.post_transforms.SigElementFallbackTransform - Fallback various desc_* nodes to inline if translator does not support them.
  - sphinx.transforms.references.SphinxDomains - Collect objects to Sphinx domains for cross references.
  - sphinx.transforms.SortIds - Sort section IDs so that the "id[0-9]+" one comes last.
  - sphinx.transforms.SphinxSmartQuotes - Customized SmartQuotes to avoid transform for some extra node types.
  - sphinx.transforms.UnreferencedFootnotesDetector - Detect unreferenced footnotes and emit warnings
  - sphinx.versioning.UIDTransform - Add UIDs to doctree for versioning.
docutils.transforms.Transformer
- sphinx.transforms.SphinxTransformer - A transformer for Sphinx.
docutils.transforms.universal.SmartQuotes
- sphinx.transforms.SphinxSmartQuotes - Customized SmartQuotes to avoid transform for some extra node types.
docutils.utils.Reporter
- sphinx.util.docutils.LoggingReporter - No class docstring; 0/1 method, 1/1 class method documented
- sphinx.util.docutils.NullReporter - A dummy reporter; write nothing.
docutils.writers.docutils_xml.Writer
- sphinx.writers.xml.PseudoXMLWriter - No class docstring; 1/2 instance variable, 1/3 class variable, 1/3 method documented
- sphinx.writers.xml.XMLWriter - Undocumented
docutils.writers.html4css1.HTMLTranslator
- sphinx.writers.html.HTMLTranslator - Our custom HTML translator.
docutils.writers.html4css1.Writer
- sphinx.writers.html.HTMLWriter - Undocumented
docutils.writers.html5_polyglot.HTMLTranslator
- sphinx.writers.html5.HTML5Translator - Our custom HTML translator.
docutils.writers.latex2e.Babel
- sphinx.builders.latex.util.ExtBabel - No class docstring; 0/3 instance variable, 0/1 class variable, 1/5 method documented
docutils.writers.manpage.Translator
- sphinx.writers.manpage.ManualPageTranslator - Custom man page translator.
docutils.writers.manpage.Writer
- sphinx.writers.manpage.ManualPageWriter - Undocumented
docutils.writers.UnfilteredWriter
- sphinx.io.SphinxDummyWriter - Dummy writer module used for generating doctree.
docutils.writers.Writer
- sphinx.writers.latex.LaTeXWriter - Undocumented
- sphinx.writers.texinfo.TexinfoWriter - Texinfo writer for generating Texinfo documents.
- sphinx.writers.text.TextWriter - Undocumented
enum.IntEnum
- sphinx.util.build_phase.BuildPhase - Build phase of Sphinx application.
Exception
- sphinx.cmd.quickstart.ValidationError - Raised for validation errors.
- sphinx.domains.c._DuplicateSymbolError - Undocumented
- sphinx.domains.cpp._DuplicateSymbolError - Undocumented
- sphinx.errors.FiletypeNotFoundError - Raised by get_filetype() if a filename matches no source suffix.
- sphinx.errors.NoUri - Raised by builder.get_relative_uri() or from missing-reference handlers if there is no URI available.
- sphinx.errors.PycodeError - Pycode Python source code analyser error.
- sphinx.errors.SphinxError - Base class for Sphinx errors.
  - sphinx.errors.ApplicationError - Application initialization error.
  - sphinx.errors.BuildEnvironmentError - BuildEnvironment error.
  - sphinx.errors.ConfigError - Configuration error.
  - sphinx.errors.DocumentError - Document error.
  - sphinx.errors.ExtensionError - Extension error.
  - sphinx.errors.SphinxParallelError - Sphinx parallel build error.
  - sphinx.errors.SphinxWarning - Warning, treated as error.
  - sphinx.errors.ThemeError - Theme error.
  - sphinx.errors.VersionRequirementError - Incompatible Sphinx version error.
  - sphinx.ext.graphviz.GraphvizError - Undocumented
  - sphinx.ext.imgmath.InvokeError - errors on invoking converters.
  - sphinx.ext.imgmath.MathExtError - Undocumented
  - sphinx.ext.linkcode.LinkcodeError - Undocumented
  - sphinx.writers.latex.UnsupportedError - Undocumented
- sphinx.ext.autosummary.ImportExceptionGroup - Exceptions raised during importing the target objects.
- sphinx.ext.inheritance_diagram.InheritanceException - Undocumented
- sphinx.util.cfamily.DefinitionError - Undocumented
- sphinx.util.cfamily.NoOldIdError - Undocumented
- sphinx.util.cfamily.UnsupportedMultiCharacterCharLiteral - Undocumented
- sphinx.util.docutils.ElementLookupError - Undocumented
- sphinx.util.SkipProgressMessage - Undocumented
Generic[T]
- sphinx.directives.ObjectDescription - Directive to describe a class, function or similar object. Not used directly, but subclassed (in domain-specific directives) to add custom behavior.
  - sphinx.domains.c.CAliasObject - No class docstring; 0/3 instance variable, 0/1 class variable, 1/1 method documented
  - sphinx.domains.cpp.CPPAliasObject - No class docstring; 0/3 instance variable, 0/1 class variable, 1/1 method documented
html.parser.HTMLParser
- sphinx.builders.linkcheck.AnchorCheckParser - Specialized HTML parser that looks for a specific anchor.
importlib.abc.Loader
- sphinx.ext.autodoc.mock.MockLoader - A loader for mocking.
importlib.abc.MetaPathFinder
- sphinx.ext.autodoc.mock.MockFinder - A finder for mocking.
jinja2.BaseLoader
- sphinx.jinja2glue.BuiltinTemplateLoader - Interfaces the rendering environment of jinja2 for use in Sphinx.
jinja2.FileSystemLoader
- sphinx.jinja2glue.SphinxFileSystemLoader - FileSystemLoader subclass that is not so strict about '..' entries in template names.
jinja2.loaders.BaseLoader
- sphinx.util.template.SphinxTemplateLoader - A loader supporting template inheritance
jinja2.parser.Parser
- sphinx.util.tags.BooleanParser - Only allow condition exprs and/or/not operations.
logging.Filter
- sphinx.util.logging.DisableWarningIsErrorFilter - Disable WarningIsErrorFilter if this filter installed.
- sphinx.util.logging.InfoFilter - Filter error and warning messages.
- sphinx.util.logging.MessagePrefixFilter - Prepend prefix to all log records.
- sphinx.util.logging.OnceFilter - Show the message only once.
- sphinx.util.logging.SphinxLogRecordTranslator - Converts a log record to one Sphinx expects
  - sphinx.util.logging.InfoLogRecordTranslator - LogRecordTranslator for INFO level log records.
  - sphinx.util.logging.WarningLogRecordTranslator - LogRecordTranslator for WARNING level log records.
- sphinx.util.logging.WarningIsErrorFilter - Raise exception if warning emitted.
- sphinx.util.logging.WarningSuppressor - Filter logs by suppress_warnings.
logging.Formatter
- sphinx.util.logging.ColorizeFormatter - Undocumented
logging.handlers.BufferingHandler
- sphinx.util.logging.MemoryHandler - Handler buffering all logs.
logging.LoggerAdapter
- sphinx.util.logging.SphinxLoggerAdapter - LoggerAdapter allowing type and subtype keywords.
logging.LogRecord
- sphinx.util.logging.SphinxLogRecord - Log record class supporting location
  - sphinx.util.logging.SphinxInfoLogRecord - Info log record class supporting location
  - sphinx.util.logging.SphinxWarningLogRecord - Warning log record class supporting location
logging.StreamHandler
- sphinx.util.logging.NewLineStreamHandler - StreamHandler which switches line terminator by record.nonl flag.
- sphinx.util.logging.WarningStreamHandler - StreamHandler for warnings.
ObjectDescription[ASTDeclaration]
- sphinx.domains.c.CObject - Description of a C language object.
  - sphinx.domains.c.CEnumeratorObject - Undocumented
  - sphinx.domains.c.CEnumObject - Undocumented
  - sphinx.domains.c.CFunctionObject - Undocumented
  - sphinx.domains.c.CMacroObject - Undocumented
  - sphinx.domains.c.CMemberObject - Undocumented
  - sphinx.domains.c.CStructObject - Undocumented
  - sphinx.domains.c.CTypeObject - Undocumented
  - sphinx.domains.c.CUnionObject - Undocumented
- sphinx.domains.cpp.CPPObject - Description of a C++ language object.
  - sphinx.domains.cpp.CPPClassObject - Undocumented
  - sphinx.domains.cpp.CPPConceptObject - Undocumented
  - sphinx.domains.cpp.CPPEnumeratorObject - Undocumented
  - sphinx.domains.cpp.CPPEnumObject - Undocumented
  - sphinx.domains.cpp.CPPFunctionObject - Undocumented
  - sphinx.domains.cpp.CPPMemberObject - Undocumented
  - sphinx.domains.cpp.CPPTypeObject - Undocumented
  - sphinx.domains.cpp.CPPUnionObject - Undocumented
ObjectDescription[str]
- sphinx.domains.rst.ReSTMarkup - Description of generic reST markup.
  - sphinx.domains.rst.ReSTDirective - Description of a reST directive.
  - sphinx.domains.rst.ReSTDirectiveOption - Description of an option for reST directive.
  - sphinx.domains.rst.ReSTRole - Description of a reST role.
- sphinx.domains.std.Cmdoption - Description of a command-line option (.. option).
- sphinx.domains.std.GenericObject - A generic x-ref directive registered with Sphinx.add_object_type().
  - sphinx.domains.std.EnvVar - Undocumented
ObjectDescription[Tuple[str, str]]
- sphinx.domains.javascript.JSObject - Description of a JavaScript object.
  - sphinx.domains.javascript.JSCallable - Description of a JavaScript function, method or constructor.
    - sphinx.domains.javascript.JSConstructor - Like a callable but with a different prefix.
- sphinx.domains.python.PyObject - Description of a general Python object.
  - sphinx.domains.python.PyAttribute - Description of an attribute.
  - sphinx.domains.python.PyClasslike - Description of a class-like object (classes, interfaces, exceptions).
  - sphinx.domains.python.PyFunction - Description of a function.
    - sphinx.domains.python.PyDecoratorFunction - Description of a decorator.
  - sphinx.domains.python.PyMethod - Description of a method.
    - sphinx.domains.python.PyClassMethod - Description of a classmethod.
    - sphinx.domains.python.PyDecoratorMethod - Description of a decoratormethod.
    - sphinx.domains.python.PyStaticMethod - Description of a staticmethod.
  - sphinx.domains.python.PyProperty - Description of an attribute.
  - sphinx.domains.python.PyVariable - Description of a variable.
PendingDeprecationWarning
- sphinx.deprecation.RemovedInSphinx60Warning - Undocumented
pygments.style.Style
- sphinx.pygments_styles.NoneStyle - Style without any styling.
- sphinx.pygments_styles.PyramidStyle - Pylons/pyramid pygments style based on friendly style, by Blaise Laflamme.
- sphinx.pygments_styles.SphinxStyle - Like friendly, but a bit darker to enhance contrast on the green background.
sphinx.addnodes.not_smartquotable - A node which does not support smart-quotes.
- sphinx.addnodes._desc_classes_injector - Helper base class for injecting a fixes list of classes.
  - sphinx.addnodes.desc_addname - Node for additional name parts for an object.
  - sphinx.addnodes.desc_inline - Node for a signature fragment in inline text.
  - sphinx.addnodes.desc_name - Node for the main object name.
  - sphinx.addnodes.desc_sig_element - Common parent class of nodes for inline text of a signature.
    - sphinx.addnodes.desc_sig_keyword - Node for a general keyword in a signature.
    - sphinx.addnodes.desc_sig_keyword_type - Node for a keyword which is a built-in type in a signature.
    - sphinx.addnodes.desc_sig_literal_char - Node for a character literal in a signature.
    - sphinx.addnodes.desc_sig_literal_number - Node for a numeric literal in a signature.
    - sphinx.addnodes.desc_sig_literal_string - Node for a string literal in a signature.
    - sphinx.addnodes.desc_sig_name - Node for an identifier in a signature.
    - sphinx.addnodes.desc_sig_operator - Node for an operator in a signature.
    - sphinx.addnodes.desc_sig_punctuation - Node for punctuation in a signature.
    - sphinx.addnodes.desc_sig_space - Node for a space in a signature.
  - sphinx.addnodes.desc_signature - Node for a single object signature.
- sphinx.addnodes.literal_emphasis - Node that behaves like emphasis, but further text processors are not applied (e.g. smartypants for HTML output).
- sphinx.addnodes.literal_strong - Node that behaves like strong, but further text processors are not applied (e.g. smartypants for HTML output).
sphinx.application.Sphinx - The main application class and extensibility interface.
- sphinx.testing.util.SphinxTestApp - A subclass of Sphinx that runs on the test root, with some better default values for the initialization parameters.
sphinx.application.TemplateBridge - This class defines the interface for a "template bridge", that is, a class that renders templates given a template name and a context.
- sphinx.jinja2glue.BuiltinTemplateLoader - Interfaces the rendering environment of jinja2 for use in Sphinx.
sphinx.builders.Builder - Builds target formats from the reST sources.
- sphinx.builders.changes.ChangesBuilder - Write a summary with all versionadded/changed directives.
- sphinx.builders.dummy.DummyBuilder - Undocumented
  - sphinx.builders.linkcheck.CheckExternalLinksBuilder - Checks for broken external links.
- sphinx.builders.gettext.I18nBuilder - General i18n builder.
  - sphinx.builders.gettext.MessageCatalogBuilder - Builds gettext-style message catalogs (.pot files).
- sphinx.builders.html.StandaloneHTMLBuilder - Builds standalone HTML docs.
  - sphinx.builders._epub_base.EpubBuilder - Builder that outputs epub files.
    - sphinx.builders.epub3.Epub3Builder - Builder that outputs epub3 files.
  - sphinx.builders.dirhtml.DirectoryHTMLBuilder - A StandaloneHTMLBuilder that creates all HTML pages as "index.html" in a directory given by their pagename, so that generated URLs don't have .html in them.
  - sphinx.builders.singlehtml.SingleFileHTMLBuilder - A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page.
- sphinx.builders.latex.LaTeXBuilder - Builds LaTeX output to create PDF.
- sphinx.builders.manpage.ManualPageBuilder - Builds groff output in manual page format.
- sphinx.builders.texinfo.TexinfoBuilder - Builds Texinfo output to create Info documentation.
- sphinx.builders.text.TextBuilder - Undocumented
- sphinx.builders.xml.XMLBuilder - Builds Docutils-native XML.
  - sphinx.builders.xml.PseudoXMLBuilder - Builds pseudo-XML for display purposes.
- sphinx.ext.coverage.CoverageBuilder - Evaluates coverage of code in the documentation.
- sphinx.ext.doctest.DocTestBuilder - Runs test snippets in the documentation.
sphinx.builders.gettext.Catalog - Catalog of translatable messages.
sphinx.builders.gettext.Message - An entry of translatable message.
sphinx.builders.gettext.MsgOrigin - Origin holder for Catalog message origin.
sphinx.builders.html._stable_repr_object - Undocumented
sphinx.builders.html.BuildInfo - buildinfo file manipulator.
sphinx.builders.latex.theming.Theme - A set of LaTeX configurations.
- sphinx.builders.latex.theming.BuiltInTheme - A built-in LaTeX theme.
- sphinx.builders.latex.theming.UserTheme - A user defined LaTeX theme.
sphinx.builders.latex.theming.ThemeFactory - A factory class for LaTeX Themes.
sphinx.builders.linkcheck.HyperlinkAvailabilityChecker - Undocumented
sphinx.cmd.make_mode.Make - Undocumented
sphinx.config.Config - Configuration file abstraction.
sphinx.config.ENUM - Represents the candidates which a config value should be one of.
sphinx.deprecation._ModuleWrapper - Undocumented
sphinx.directives.code.LiteralIncludeReader - Undocumented
sphinx.domains.c.LookupKey - Undocumented
sphinx.domains.c.Symbol - Undocumented
sphinx.domains.c.SymbolLookupResult - Undocumented
sphinx.domains.cpp.LookupKey - Undocumented
sphinx.domains.cpp.Symbol - Undocumented
sphinx.domains.cpp.SymbolLookupResult - Undocumented
sphinx.domains.Domain - No summary
- sphinx.domains.c.CDomain - C language domain.
- sphinx.domains.changeset.ChangeSetDomain - Domain for changesets.
- sphinx.domains.citation.CitationDomain - Domain for citations.
- sphinx.domains.cpp.CPPDomain - C++ language domain.
- sphinx.domains.index.IndexDomain - Mathematics domain.
- sphinx.domains.javascript.JavaScriptDomain - JavaScript language domain.
- sphinx.domains.math.MathDomain - Mathematics domain.
- sphinx.domains.python.PythonDomain - Python language domain.
- sphinx.domains.rst.ReSTDomain - ReStructuredText domain.
- sphinx.domains.std.StandardDomain - Domain for all objects that don't fit into another domain or are added via the application interface.
- sphinx.ext.duration.DurationDomain - A domain for durations of Sphinx processing.
- sphinx.ext.todo.TodoDomain - Undocumented
sphinx.domains.ObjType - An ObjType is the description for a type of object that a domain can document. In the object_types attribute of Domain subclasses, object type names are mapped to instances of this class.
sphinx.domains.python.PyDecoratorMixin - Mixin for decorator directives.
sphinx.domains.python.PyXrefMixin - Undocumented
- sphinx.domains.python.PyField - Undocumented
- sphinx.domains.python.PyGroupedField - Undocumented
- sphinx.domains.python.PyTypedField - Undocumented
sphinx.environment.adapters.asset.ImageAdapter - No class docstring; 0/1 instance variable, 1/2 method documented
sphinx.environment.adapters.indexentries.IndexEntries - No class docstring; 0/1 instance variable, 1/2 method documented
sphinx.environment.adapters.toctree.TocTree - No class docstring; 0/1 instance variable, 5/7 methods documented
sphinx.environment.BuildEnvironment - The environment in which the ReST files are translated. Stores an inventory of cross-file targets and provides doctree transformations to resolve links to them.
sphinx.environment.collectors.EnvironmentCollector - An EnvironmentCollector is a specific data collector from each document.
- sphinx.environment.collectors.asset.DownloadFileCollector - Download files collector for sphinx.environment.
- sphinx.environment.collectors.asset.ImageCollector - Image files collector for sphinx.environment.
- sphinx.environment.collectors.dependencies.DependenciesCollector - dependencies collector for sphinx.environment.
- sphinx.environment.collectors.metadata.MetadataCollector - metadata collector for sphinx.environment.
- sphinx.environment.collectors.title.TitleCollector - title collector for sphinx.environment.
- sphinx.environment.collectors.toctree.TocTreeCollector - No class docstring; 3/6 methods documented
sphinx.events.EventManager - Event manager for Sphinx.
sphinx.ext.autodoc._All - A special value for :*-members: that matches to any member.
sphinx.ext.autodoc._Empty - A special value for :exclude-members: that never matches to any member.
sphinx.ext.autodoc.DataDocumenterMixinBase - No class docstring; 0/6 class variable, 3/3 methods documented
- sphinx.ext.autodoc.GenericAliasMixin - Mixin for DataDocumenter and AttributeDocumenter to provide the feature for supporting GenericAliases.
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
  - sphinx.ext.autodoc.DataDocumenter - Specialized Documenter subclass for data items.
    - sphinx.ext.autodoc.deprecated.DataDeclarationDocumenter - Specialized Documenter subclass for data that cannot be imported because they are declared without initial value (refs: PEP-526).
    - sphinx.ext.autodoc.deprecated.GenericAliasDocumenter - Specialized Documenter subclass for GenericAliases.
    - sphinx.ext.autodoc.deprecated.TypeVarDocumenter - Specialized Documenter subclass for TypeVars.
    - sphinx.ext.autodoc.NewTypeDataDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.NewTypeMixin - Mixin for DataDocumenter and AttributeDocumenter to provide the feature for supporting NewTypes.
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
  - sphinx.ext.autodoc.DataDocumenter - Specialized Documenter subclass for data items.
    - sphinx.ext.autodoc.deprecated.DataDeclarationDocumenter - Specialized Documenter subclass for data that cannot be imported because they are declared without initial value (refs: PEP-526).
    - sphinx.ext.autodoc.deprecated.GenericAliasDocumenter - Specialized Documenter subclass for GenericAliases.
    - sphinx.ext.autodoc.deprecated.TypeVarDocumenter - Specialized Documenter subclass for TypeVars.
    - sphinx.ext.autodoc.NewTypeDataDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.NonDataDescriptorMixin - Mixin for AttributeDocumenter to provide the feature for supporting non data-descriptors.
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.RuntimeInstanceAttributeMixin - Mixin for AttributeDocumenter to provide the feature for supporting runtime instance attributes (that are defined in __init__() methods with doc-comments).
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.SlotsMixin - Mixin for AttributeDocumenter to provide the feature for supporting __slots__.
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.TypeVarMixin - Mixin for DataDocumenter and AttributeDocumenter to provide the feature for supporting TypeVars.
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
  - sphinx.ext.autodoc.DataDocumenter - Specialized Documenter subclass for data items.
    - sphinx.ext.autodoc.deprecated.DataDeclarationDocumenter - Specialized Documenter subclass for data that cannot be imported because they are declared without initial value (refs: PEP-526).
    - sphinx.ext.autodoc.deprecated.GenericAliasDocumenter - Specialized Documenter subclass for GenericAliases.
    - sphinx.ext.autodoc.deprecated.TypeVarDocumenter - Specialized Documenter subclass for TypeVars.
    - sphinx.ext.autodoc.NewTypeDataDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.UninitializedGlobalVariableMixin - Mixin for DataDocumenter to provide the feature for supporting uninitialized (type annotation only) global variables.
  - sphinx.ext.autodoc.DataDocumenter - Specialized Documenter subclass for data items.
    - sphinx.ext.autodoc.deprecated.DataDeclarationDocumenter - Specialized Documenter subclass for data that cannot be imported because they are declared without initial value (refs: PEP-526).
    - sphinx.ext.autodoc.deprecated.GenericAliasDocumenter - Specialized Documenter subclass for GenericAliases.
    - sphinx.ext.autodoc.deprecated.TypeVarDocumenter - Specialized Documenter subclass for TypeVars.
    - sphinx.ext.autodoc.NewTypeDataDocumenter - Specialized Documenter subclass for NewTypes.
- sphinx.ext.autodoc.UninitializedInstanceAttributeMixin - Mixin for AttributeDocumenter to provide the feature for supporting uninitialized instance attributes (PEP-526 styled, annotation only attributes).
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
sphinx.ext.autodoc.directive.DocumenterBridge - A parameters container for Documenters.
- sphinx.ext.autosummary.FakeDirective - Undocumented
sphinx.ext.autodoc.DocstringSignatureMixin - Mixin for FunctionDocumenter and MethodDocumenter to provide the feature of reading the signature from the docstring.
- sphinx.ext.autodoc.ClassDocumenter - Specialized Documenter subclass for classes.
  - sphinx.ext.autodoc.ExceptionDocumenter - Specialized ClassDocumenter subclass for exceptions.
- sphinx.ext.autodoc.DocstringStripSignatureMixin - Mixin for AttributeDocumenter to provide the feature of stripping any function signature from the docstring.
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
  - sphinx.ext.autodoc.PropertyDocumenter - Specialized Documenter subclass for properties.
- sphinx.ext.autodoc.FunctionDocumenter - Specialized Documenter subclass for functions.
  - sphinx.ext.autodoc.DecoratorDocumenter - Specialized Documenter subclass for decorator functions.
  - sphinx.ext.autodoc.deprecated.SingledispatchFunctionDocumenter - Used to be a specialized Documenter subclass for singledispatch'ed functions.
- sphinx.ext.autodoc.MethodDocumenter - Specialized Documenter subclass for methods (normal, static and class).
  - sphinx.ext.autodoc.deprecated.SingledispatchMethodDocumenter - Used to be a specialized Documenter subclass for singledispatch'ed methods.
sphinx.ext.autodoc.Documenter - A Documenter knows how to autodocument a single object type. When registered with the AutoDirective, it will be used to document objects of that type when needed by autodoc.
- sphinx.ext.autodoc.ClassLevelDocumenter - Specialized Documenter subclass for objects on class level (methods, attributes).
  - sphinx.ext.autodoc.AttributeDocumenter - Specialized Documenter subclass for attributes.
    - sphinx.ext.autodoc.deprecated.InstanceAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are instance attributes (e.g. assigned in __init__).
    - sphinx.ext.autodoc.deprecated.SlotsAttributeDocumenter - Specialized Documenter subclass for attributes that cannot be imported because they are attributes in __slots__.
    - sphinx.ext.autodoc.NewTypeAttributeDocumenter - Specialized Documenter subclass for NewTypes.
  - sphinx.ext.autodoc.MethodDocumenter - Specialized Documenter subclass for methods (normal, static and class).
    - sphinx.ext.autodoc.deprecated.SingledispatchMethodDocumenter - Used to be a specialized Documenter subclass for singledispatch'ed methods.
  - sphinx.ext.autodoc.PropertyDocumenter - Specialized Documenter subclass for properties.
- sphinx.ext.autodoc.ModuleDocumenter - Specialized Documenter subclass for modules.
- sphinx.ext.autodoc.ModuleLevelDocumenter - Specialized Documenter subclass for objects on module level (functions, classes, data/constants).
  - sphinx.ext.autodoc.ClassDocumenter - Specialized Documenter subclass for classes.
    - sphinx.ext.autodoc.ExceptionDocumenter - Specialized ClassDocumenter subclass for exceptions.
  - sphinx.ext.autodoc.DataDocumenter - Specialized Documenter subclass for data items.
    - sphinx.ext.autodoc.deprecated.DataDeclarationDocumenter - Specialized Documenter subclass for data that cannot be imported because they are declared without initial value (refs: PEP-526).
    - sphinx.ext.autodoc.deprecated.GenericAliasDocumenter - Specialized Documenter subclass for GenericAliases.
    - sphinx.ext.autodoc.deprecated.TypeVarDocumenter - Specialized Documenter subclass for TypeVars.
    - sphinx.ext.autodoc.NewTypeDataDocumenter - Specialized Documenter subclass for NewTypes.
  - sphinx.ext.autodoc.FunctionDocumenter - Specialized Documenter subclass for functions.
    - sphinx.ext.autodoc.DecoratorDocumenter - Specialized Documenter subclass for decorator functions.
    - sphinx.ext.autodoc.deprecated.SingledispatchFunctionDocumenter - Used to be a specialized Documenter subclass for singledispatch'ed functions.
sphinx.ext.autodoc.mock._MockObject - Used by autodoc_mock_imports.
sphinx.ext.autodoc.preserve_defaults.DefaultValue - Undocumented
sphinx.ext.autosummary.FakeApplication - Undocumented
sphinx.ext.autosummary.generate.AutosummaryRenderer - A helper class for rendering.
sphinx.ext.autosummary.generate.DummyApplication - Dummy Application class for sphinx-autogen command.
sphinx.ext.autosummary.generate.ModuleScanner - Undocumented
sphinx.ext.doctest.TestCode - Undocumented
sphinx.ext.doctest.TestGroup - Undocumented
sphinx.ext.graphviz.ClickableMapDefinition - A manipulator for clickable map file of graphviz.
sphinx.ext.inheritance_diagram.InheritanceGraph - Given a list of classes, determines the set of classes that they inherit from all the way to the root "object", and then is able to generate a graphviz dot graph from them.
sphinx.ext.intersphinx.InventoryAdapter - Inventory adapter for environment
sphinx.ext.napoleon.Config - Sphinx napoleon extension settings in conf.py.
sphinx.ext.napoleon.docstring.GoogleDocstring - Convert Google style docstrings to reStructuredText.
- sphinx.ext.napoleon.docstring.NumpyDocstring - Convert NumPy style docstrings to reStructuredText.
sphinx.ext.napoleon.iterators.peek_iter - An iterator object that supports peeking ahead.
- sphinx.ext.napoleon.iterators.modify_iter - An iterator object that supports modifying items as they are returned.
sphinx.ext.todo.TodoListProcessor - No class docstring; 0/5 instance variable, 1/4 method documented
sphinx.extension.Extension - Undocumented
sphinx.highlighting.PygmentsBridge - Undocumented
sphinx.jinja2glue.idgen - Undocumented
sphinx.project.Project - A project is the source code set of the Sphinx document(s).
sphinx.pycode.ast.ast.NodeVisitor
- sphinx.pycode.parser.VariableCommentPicker - Python source code parser to pick up variable comments.
sphinx.pycode.ModuleAnalyzer - No class docstring; 0/10 instance variable, 0/1 class variable, 4/5 methods, 1/1 static method, 0/4 class method documented
sphinx.pycode.parser.Parser - Python source code parser to pick up variable comments.
sphinx.pycode.parser.Token - Better token wrapper for tokenize module.
sphinx.pycode.parser.TokenProcessor - No class docstring; 0/4 instance variable, 3/4 methods documented
- sphinx.pycode.parser.AfterCommentParser - Python source code parser to pick up comments after assignments.
- sphinx.pycode.parser.DefinitionFinder - Python source code parser to detect location of functions, classes and methods.
sphinx.registry.SphinxComponentRegistry - No class docstring; 0/24 instance variable, 1/37 method documented
sphinx.roles.SphinxRole
- sphinx.domains.c.CExprRole - Undocumented
- sphinx.domains.cpp.CPPExprRole - Undocumented
sphinx.search._JavaScriptIndex - The search index as JavaScript file that calls a function on the documentation search object to register the index.
sphinx.search.IndexBuilder - Helper class that creates a search index based on the doctrees passed to the feed method.
sphinx.search.ja.BaseSplitter - No class docstring; 0/1 instance variable, 1/2 method documented
- sphinx.search.ja.DefaultSplitter - Undocumented
- sphinx.search.ja.JanomeSplitter - Undocumented
- sphinx.search.ja.MecabSplitter - Undocumented
sphinx.search.SearchLanguage - This class is the base class for search natural language preprocessors. If you want to add support for a new language, you should override the methods of this class.
- sphinx.search.da.SearchDanish - Undocumented
- sphinx.search.de.SearchGerman - Undocumented
- sphinx.search.en.SearchEnglish - Undocumented
- sphinx.search.es.SearchSpanish - Undocumented
- sphinx.search.fi.SearchFinnish - Undocumented
- sphinx.search.fr.SearchFrench - Undocumented
- sphinx.search.hu.SearchHungarian - Undocumented
- sphinx.search.it.SearchItalian - Undocumented
- sphinx.search.ja.SearchJapanese - Japanese search implementation: uses no stemmer, but word splitting is quite complicated.
- sphinx.search.nl.SearchDutch - Undocumented
- sphinx.search.no.SearchNorwegian - Undocumented
- sphinx.search.pt.SearchPortuguese - Undocumented
- sphinx.search.ro.SearchRomanian - Undocumented
- sphinx.search.ru.SearchRussian - Undocumented
- sphinx.search.sv.SearchSwedish - Undocumented
- sphinx.search.tr.SearchTurkish - Undocumented
- sphinx.search.zh.SearchChinese - Chinese search implementation
sphinx.testing.comparer.PathComparer - OS-independent path comparison.
sphinx.testing.fixtures.SharedResult - Undocumented
sphinx.testing.util.SphinxTestAppWrapperForSkipBuilding - This class is a wrapper for SphinxTestApp to speed up the test by skipping app.build process if it is already built and there is even one output file.
sphinx.testing.util.Struct - Undocumented
sphinx.theming.HTMLThemeFactory - A factory class for HTML Themes.
sphinx.theming.Theme - A Theme is a set of HTML templates and configurations.
sphinx.util.cfamily.ASTBaseBase - Undocumented
- sphinx.domains.c.ASTBase - Undocumented
  - sphinx.domains.c.ASTArray - Undocumented
  - sphinx.domains.c.ASTBinOpExpr - Undocumented
  - sphinx.domains.c.ASTBracedInitList - Undocumented
  - sphinx.domains.c.ASTDeclarator - Undocumented
    - sphinx.domains.c.ASTDeclaratorNameBitField - Undocumented
    - sphinx.domains.c.ASTDeclaratorNameParam - Undocumented
    - sphinx.domains.c.ASTDeclaratorParen - Undocumented
    - sphinx.domains.c.ASTDeclaratorPtr - Undocumented
  - sphinx.domains.c.ASTDeclSpecs - Undocumented
  - sphinx.domains.c.ASTEnum - Undocumented
  - sphinx.domains.c.ASTEnumerator - Undocumented
  - sphinx.domains.c.ASTExpression - Undocumented
    - sphinx.domains.c.ASTAlignofExpr - Undocumented
    - sphinx.domains.c.ASTAssignmentExpr - Undocumented
    - sphinx.domains.c.ASTCastExpr - Undocumented
    - sphinx.domains.c.ASTFallbackExpr - Undocumented
    - sphinx.domains.c.ASTIdExpression - Undocumented
    - sphinx.domains.c.ASTLiteral - Undocumented
      - sphinx.domains.c.ASTBooleanLiteral - Undocumented
      - sphinx.domains.c.ASTCharLiteral - Undocumented
      - sphinx.domains.c.ASTNumberLiteral - Undocumented
      - sphinx.domains.c.ASTStringLiteral - Undocumented
    - sphinx.domains.c.ASTParenExpr - Undocumented
    - sphinx.domains.c.ASTPostfixExpr - Undocumented
    - sphinx.domains.c.ASTSizeofExpr - Undocumented
    - sphinx.domains.c.ASTSizeofType - Undocumented
    - sphinx.domains.c.ASTUnaryOpExpr - Undocumented
  - sphinx.domains.c.ASTFunctionParameter - Undocumented
  - sphinx.domains.c.ASTInitializer - Undocumented
  - sphinx.domains.c.ASTMacro - Undocumented
  - sphinx.domains.c.ASTMacroParameter - Undocumented
  - sphinx.domains.c.ASTNestedName - Undocumented
  - sphinx.domains.c.ASTParameters - Undocumented
  - sphinx.domains.c.ASTPostfixOp - Undocumented
    - sphinx.domains.c.ASTPostfixArray - Undocumented
    - sphinx.domains.c.ASTPostfixCallExpr - Undocumented
    - sphinx.domains.c.ASTPostfixDec - Undocumented
    - sphinx.domains.c.ASTPostfixInc - Undocumented
    - sphinx.domains.c.ASTPostfixMemberOfPointer - Undocumented
  - sphinx.domains.c.ASTStruct - Undocumented
  - sphinx.domains.c.ASTTrailingTypeSpec - Undocumented
    - sphinx.domains.c.ASTTrailingTypeSpecFundamental - Undocumented
    - sphinx.domains.c.ASTTrailingTypeSpecName - Undocumented
  - sphinx.domains.c.ASTType - Undocumented
  - sphinx.domains.c.ASTTypeWithInit - Undocumented
  - sphinx.domains.c.ASTUnion - Undocumented
- sphinx.domains.c.ASTDeclaration - Undocumented
- sphinx.domains.c.ASTDeclSpecsSimple - Undocumented
- sphinx.domains.c.ASTIdentifier - Undocumented
- sphinx.domains.cpp.ASTBase - Undocumented
  - sphinx.domains.cpp.ASTArray - Undocumented
  - sphinx.domains.cpp.ASTBaseClass - Undocumented
  - sphinx.domains.cpp.ASTBracedInitList - Undocumented
  - sphinx.domains.cpp.ASTClass - Undocumented
  - sphinx.domains.cpp.ASTConcept - Undocumented
  - sphinx.domains.cpp.ASTDeclaration - Undocumented
  - sphinx.domains.cpp.ASTDeclarator - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorMemPtr - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorNameBitField - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorNameParamQual - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorParamPack - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorParen - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorPtr - Undocumented
    - sphinx.domains.cpp.ASTDeclaratorRef - Undocumented
  - sphinx.domains.cpp.ASTDeclSpecs - Undocumented
  - sphinx.domains.cpp.ASTDeclSpecsSimple - Undocumented
  - sphinx.domains.cpp.ASTEnum - Undocumented
  - sphinx.domains.cpp.ASTEnumerator - Undocumented
  - sphinx.domains.cpp.ASTExplicitSpec - Undocumented
  - sphinx.domains.cpp.ASTExpression - Undocumented
    - sphinx.domains.cpp.ASTAlignofExpr - Undocumented
    - sphinx.domains.cpp.ASTAssignmentExpr - Undocumented
    - sphinx.domains.cpp.ASTBinOpExpr - Undocumented
    - sphinx.domains.cpp.ASTCastExpr - Undocumented
    - sphinx.domains.cpp.ASTCommaExpr - Undocumented
    - sphinx.domains.cpp.ASTDeleteExpr - Undocumented
    - sphinx.domains.cpp.ASTExplicitCast - Undocumented
    - sphinx.domains.cpp.ASTFallbackExpr - Undocumented
    - sphinx.domains.cpp.ASTFoldExpr - Undocumented
    - sphinx.domains.cpp.ASTIdExpression - Undocumented
    - sphinx.domains.cpp.ASTLiteral - Undocumented
      - sphinx.domains.cpp.ASTBooleanLiteral - Undocumented
      - sphinx.domains.cpp.ASTCharLiteral - Undocumented
      - sphinx.domains.cpp.ASTNumberLiteral - Undocumented
      - sphinx.domains.cpp.ASTPointerLiteral - Undocumented
      - sphinx.domains.cpp.ASTStringLiteral - Undocumented
      - sphinx.domains.cpp.ASTUserDefinedLiteral - Undocumented
    - sphinx.domains.cpp.ASTNewExpr - Undocumented
    - sphinx.domains.cpp.ASTNoexceptExpr - Undocumented
    - sphinx.domains.cpp.ASTPackExpansionExpr - Undocumented
    - sphinx.domains.cpp.ASTParenExpr - Undocumented
    - sphinx.domains.cpp.ASTPostfixExpr - Undocumented
    - sphinx.domains.cpp.ASTSizeofExpr - Undocumented
    - sphinx.domains.cpp.ASTSizeofParamPack - Undocumented
    - sphinx.domains.cpp.ASTSizeofType - Undocumented
    - sphinx.domains.cpp.ASTThisLiteral - Undocumented
    - sphinx.domains.cpp.ASTTypeId - Undocumented
    - sphinx.domains.cpp.ASTUnaryOpExpr - Undocumented
  - sphinx.domains.cpp.ASTFunctionParameter - Undocumented
  - sphinx.domains.cpp.ASTIdentifier - Undocumented
  - sphinx.domains.cpp.ASTInitializer - Undocumented
  - sphinx.domains.cpp.ASTNamespace - Undocumented
  - sphinx.domains.cpp.ASTNestedName - Undocumented
  - sphinx.domains.cpp.ASTNestedNameElement - Undocumented
  - sphinx.domains.cpp.ASTNoexceptSpec - Undocumented
  - sphinx.domains.cpp.ASTOperator - No class docstring; 1/5 method documented
    - sphinx.domains.cpp.ASTOperatorBuildIn - Undocumented
    - sphinx.domains.cpp.ASTOperatorLiteral - Undocumented
    - sphinx.domains.cpp.ASTOperatorType - Undocumented
  - sphinx.domains.cpp.ASTParametersQualifiers - Undocumented
  - sphinx.domains.cpp.ASTPostfixOp - Undocumented
    - sphinx.domains.cpp.ASTPostfixArray - Undocumented
    - sphinx.domains.cpp.ASTPostfixCallExpr - Undocumented
    - sphinx.domains.cpp.ASTPostfixDec - Undocumented
    - sphinx.domains.cpp.ASTPostfixInc - Undocumented
    - sphinx.domains.cpp.ASTPostfixMember - Undocumented
    - sphinx.domains.cpp.ASTPostfixMemberOfPointer - Undocumented
  - sphinx.domains.cpp.ASTRequiresClause - Undocumented
  - sphinx.domains.cpp.ASTTemplateArgConstant - Undocumented
  - sphinx.domains.cpp.ASTTemplateArgs - Undocumented
  - sphinx.domains.cpp.ASTTemplateDeclarationPrefix - Undocumented
  - sphinx.domains.cpp.ASTTemplateIntroduction - Undocumented
  - sphinx.domains.cpp.ASTTemplateIntroductionParameter - Undocumented
  - sphinx.domains.cpp.ASTTemplateParam - Undocumented
    - sphinx.domains.cpp.ASTTemplateKeyParamPackIdDefault - Undocumented
    - sphinx.domains.cpp.ASTTemplateParamNonType - Undocumented
    - sphinx.domains.cpp.ASTTemplateParamTemplateType - Undocumented
    - sphinx.domains.cpp.ASTTemplateParamType - Undocumented
  - sphinx.domains.cpp.ASTTemplateParamConstrainedTypeWithInit - Undocumented
  - sphinx.domains.cpp.ASTTemplateParams - Undocumented
  - sphinx.domains.cpp.ASTTrailingTypeSpec - Undocumented
    - sphinx.domains.cpp.ASTTrailingTypeSpecDecltype - Undocumented
    - sphinx.domains.cpp.ASTTrailingTypeSpecDecltypeAuto - Undocumented
    - sphinx.domains.cpp.ASTTrailingTypeSpecFundamental - Undocumented
    - sphinx.domains.cpp.ASTTrailingTypeSpecName - Undocumented
  - sphinx.domains.cpp.ASTType - Undocumented
  - sphinx.domains.cpp.ASTTypeUsing - Undocumented
  - sphinx.domains.cpp.ASTTypeWithInit - Undocumented
  - sphinx.domains.cpp.ASTUnion - Undocumented
- sphinx.util.cfamily.ASTAttribute - Undocumented
  - sphinx.util.cfamily.ASTCPPAttribute - Undocumented
  - sphinx.util.cfamily.ASTGnuAttributeList - Undocumented
  - sphinx.util.cfamily.ASTIdAttribute - For simple attributes defined by the user.
  - sphinx.util.cfamily.ASTParenAttribute - For paren attributes defined by the user.
- sphinx.util.cfamily.ASTBaseParenExprList - Undocumented
  - sphinx.domains.c.ASTParenExprList - Undocumented
  - sphinx.domains.cpp.ASTParenExprList - Undocumented
- sphinx.util.cfamily.ASTGnuAttribute - Undocumented
sphinx.util.cfamily.BaseParser - Undocumented
- sphinx.domains.c.DefinitionParser - No class docstring; 0/3 property, 0/1 instance variable, 2/38 methods documented
- sphinx.domains.cpp.DefinitionParser - No class docstring; 0/3 property, 0/1 instance variable, 2/47 methods documented
sphinx.util.docfields.DocFieldTransformer - Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain.
sphinx.util.docfields.Field - A doc field that is never grouped. It can have an argument or not, the argument can be linked using a specified rolename. Field should be used for doc fields that usually don't occur more than once.
- sphinx.domains.python.PyField - Undocumented
- sphinx.util.docfields.GroupedField - No summary
  - sphinx.domains.python.PyGroupedField - Undocumented
  - sphinx.util.docfields.TypedField - A doc field that is grouped and has type information for the arguments. It always has an argument. The argument can be linked using the given rolename, the type using the given typerolename.
    - sphinx.domains.python.PyTypedField - Undocumented
sphinx.util.docutils.CustomReSTDispatcher - Custom reST's mark-up dispatcher.
- sphinx.ext.intersphinx.IntersphinxDispatcher - Custom dispatcher for external role.
- sphinx.util.docutils.sphinx_domains - Monkey-patch directive and role dispatch, so that domain-specific markup takes precedence.
sphinx.util.docutils.SphinxRole - A base class for Sphinx roles.
- sphinx.ext.autosummary.AutoLink - Smart linking role.
- sphinx.ext.intersphinx.IntersphinxRole - Undocumented
- sphinx.roles.Abbreviation - Undocumented
- sphinx.roles.EmphasizedLiteral - Undocumented
- sphinx.roles.GUILabel - Undocumented
  - sphinx.roles.MenuSelection - Undocumented
- sphinx.util.docutils.ReferenceRole - A base class for reference roles.
  - sphinx.domains.index.IndexRole - Undocumented
  - sphinx.roles.PEP - Undocumented
  - sphinx.roles.RFC - Undocumented
  - sphinx.roles.XRefRole - A generic cross-referencing role. To create a callable that can be used as a role function, create an instance of this class.
    - sphinx.domains.c.CXRefRole - Undocumented
    - sphinx.domains.cpp.CPPXRefRole - Undocumented
    - sphinx.domains.javascript.JSXRefRole - Undocumented
    - sphinx.domains.math.MathReferenceRole - Undocumented
    - sphinx.domains.python.PyXRefRole - Undocumented
    - sphinx.domains.std.EnvVarXRefRole - Cross-referencing role for environment variables (adds an index entry).
    - sphinx.domains.std.OptionXRefRole - Undocumented
    - sphinx.domains.std.TokenXRefRole - Undocumented
    - sphinx.roles.AnyXRefRole - Undocumented
sphinx.util.docutils.WarningStream - Undocumented
sphinx.util.i18n.CatalogRepository - A repository for message catalogs.
sphinx.util.inspect.DefaultValue - A simple wrapper for default value of the parameters of overload functions.
sphinx.util.inspect.TypeAliasForwardRef - Pseudo typing class for autodoc_type_aliases.
sphinx.util.inspect.TypeAliasModule - Pseudo module class for autodoc_type_aliases.
sphinx.util.inventory.InventoryFile - Undocumented
sphinx.util.inventory.InventoryFileReader - A file reader for an inventory file.
sphinx.util.logging.LastMessagesWriter - Stream writer storing last 10 messages in memory to save trackback
sphinx.util.logging.LogCollector - Undocumented
sphinx.util.logging.SafeEncodingWriter - Stream writer which ignores UnicodeEncodeError silently
sphinx.util.matching.Matcher - A pattern matcher for Multiple shell-style glob patterns.
sphinx.util.nodes.NodeMatcher - A helper class for Node.findall().
sphinx.util.osutil.FileAvoidWrite - File-like object that buffers output and only writes if content changed.
sphinx.util.parallel.ParallelTasks - Executes nproc tasks in parallel after forking.
sphinx.util.parallel.SerialTasks - Has the same interface as ParallelTasks, but executes tasks directly.
sphinx.util.progress_message - Undocumented
sphinx.util.stemmer.BaseStemmer - Undocumented
- sphinx.util.stemmer.PyStemmer - Undocumented
- sphinx.util.stemmer.StandardStemmer - All those porter stemmer implementations look hideous; make at least the stem method nicer.
sphinx.util.stemmer.porter.PorterStemmer - No class docstring; 0/4 instance variable, 16/16 methods documented
- sphinx.util.stemmer.StandardStemmer - All those porter stemmer implementations look hideous; make at least the stem method nicer.
sphinx.util.tags.Tags - Undocumented
- sphinx.builders.gettext.I18nTags - Dummy tags module for I18nBuilder.
sphinx.util.Tee - File-like object writing to two streams.
sphinx.util.template.BaseRenderer - Undocumented
- sphinx.util.template.FileRenderer - Undocumented
  - sphinx.util.template.SphinxRenderer - Undocumented
    - sphinx.builders.gettext.GettextRenderer - Undocumented
    - sphinx.cmd.quickstart.QuickstartRenderer - No class docstring; 0/1 instance variable, 1/3 method documented
    - sphinx.util.template.LaTeXRenderer - Undocumented
    - sphinx.util.template.ReSTRenderer - Undocumented
sphinx.util.UnicodeDecodeErrorHandler - Custom error handler for open() that warns and replaces.
sphinx.writers.latex.Table - A table data
sphinx.writers.latex.TableCell - Data of a cell in a table.
sphinx.writers.manpage.NestedInlineTransform - Flatten nested inline nodes:
sphinx.writers.text.Cell - Represents a cell in a table. It can span multiple columns or multiple lines.
sphinx.writers.text.Table - Represents a table, handling cells that can span multiple lines or rows, like:
str
- sphinx.builders.html.JavaScript - A metadata of javascript file.
- sphinx.builders.html.Stylesheet - A metadata of stylesheet.
- sphinx.testing.path.path - Represents a path which behaves like a string.
textwrap.TextWrapper
- sphinx.writers.text.TextWrapper - Custom subclass that uses a different word separator regex.
threading.Thread
- sphinx.builders.linkcheck.HyperlinkAvailabilityCheckWorker - A worker class for checking the availability of hyperlinks.
tuple
- sphinx.ext.autodoc.ObjectMember - A member of object.
types.ModuleType
- sphinx.ext.autodoc.mock._MockModule - Used by autodoc_mock_imports.
typing.NamedTuple
- sphinx.builders._epub_base.Guide - Undocumented
- sphinx.builders._epub_base.ManifestItem - Undocumented
- sphinx.builders._epub_base.NavPoint - Undocumented
- sphinx.builders._epub_base.Spine - Undocumented
- sphinx.builders.epub3.NavPoint - Undocumented
- sphinx.builders.linkcheck.CheckRequest - Undocumented
- sphinx.builders.linkcheck.CheckResult - Undocumented
- sphinx.builders.linkcheck.Hyperlink - Undocumented
- sphinx.builders.linkcheck.RateLimit - Undocumented
- sphinx.config.ConfigValue - Undocumented
- sphinx.domains.changeset.ChangeSet - Undocumented
- sphinx.domains.IndexEntry - Undocumented
- sphinx.domains.python.ModuleEntry - Undocumented
- sphinx.domains.python.ObjectEntry - Undocumented
- sphinx.events.EventListener - Undocumented
- sphinx.ext.autodoc.importer.Attribute - Undocumented
- sphinx.ext.autosummary.generate.AutosummaryEntry - Undocumented
- sphinx.transforms.post_transforms.code.HighlightSetting - Undocumented
- sphinx.util.i18n.LocaleFileInfoBase - Undocumented
  - sphinx.util.i18n.CatalogInfo - Undocumented
- sphinx.util.images.DataURI - Undocumented