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/20 method documentedsphinx.pycode.parser.VariableCommentPicker
- Python source code parser to pick up variable comments.collections.deque
sphinx.ext.napoleon.docstring.Deque
- A subclass of deque that mimics ``pockets.iterators.modify_iter``.datetime.tzinfo
sphinx.builders.gettext.LocalTimeZone
- UndocumentedDeprecationWarning
sphinx.deprecation.RemovedInSphinx70Warning
- Undocumenteddict
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.doctest.DocTestRunner
sphinx.ext.doctest.SphinxDocTestRunner
- Undocumenteddocutils.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
- Undocumenteddocutils.nodes.BackLinkable
sphinx.builders.latex.nodes.footnotetext
- Broken description
docutils.nodes.comment
sphinx.ext.autosummary.autosummary_table
- Undocumentedsphinx.ext.autosummary.autosummary_toc
- Undocumenteddocutils.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 fixed 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.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
- Broken description
sphinx.domains.c.AliasNode
- Undocumentedsphinx.domains.cpp.AliasNode
- Undocumentedsphinx.ext.graphviz.graphviz
- Undocumentedsphinx.ext.inheritance_diagram.inheritance_diagram
- A docutils node to use as a placeholder for the inheritance diagram.sphinx.ext.ifconfig.ifconfig
- Undocumentedsphinx.ext.todo.todo_node
- Undocumentedsphinx.ext.todo.todolist
- Undocumentedsphinx.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
- Broken description
sphinx.ext.graphviz.graphviz
- Undocumentedsphinx.ext.inheritance_diagram.inheritance_diagram
- A docutils node to use as a placeholder for the inheritance diagram.sphinx.ext.todo.todolist
- Undocumenteddocutils.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 representing a potential way to create a cross-reference and the condition in which this way should be used.sphinx.addnodes.production
- Node for a single grammar production rule.sphinx.builders.latex.nodes.footnotemark
- Broken description
sphinx.builders.latex.nodes.math_reference
- A node for a reference for equation.sphinx.ext.graphviz.graphviz
- Undocumentedsphinx.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
- Broken description
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 documentsphinx.builders.latex.transforms.LaTeXFootnoteVisitor
- Undocumentedsphinx.search.WordCollector
- A special visitor that collects words for the `IndexBuilder`.sphinx.transforms.post_transforms.code.HighlightLanguageVisitor
- Undocumentedsphinx.util.docutils.SphinxTranslator
- A base class for Sphinx translators.sphinx.writers._html4.HTML4Translator
- Our custom HTML translator.sphinx.writers.html5.HTML5Translator
- Our custom HTML translator.sphinx.writers.latex.LaTeXTranslator
- No class docstring; 2/2 properties, 0/33 instance variable, 0/3 class variable, 2/222 methods documentedsphinx.writers.manpage.ManualPageTranslator
- Custom man page translator.sphinx.writers.texinfo.TexinfoTranslator
- No class docstring; 0/31 instance variable, 0/5 class variable, 9/222 methods documentedsphinx.writers.text.TextTranslator
- Undocumenteddocutils.nodes.paragraph
sphinx.addnodes.compact_paragraph
- Node for a compact paragraph (which never makes a <p> node).docutils.nodes.Part
sphinx.addnodes.centered
- This node is 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.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
- Broken description
sphinx.builders.latex.nodes.math_reference
- A node for a reference for equation.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
- Broken description
docutils.nodes.TextElement
sphinx.addnodes.centered
- This node is 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 representing a potential way to create a cross-reference and the condition in which this way should be used.sphinx.addnodes.versionmodified
- Node for version change entries.sphinx.builders.latex.nodes.footnotemark
- Broken description
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 documentedsphinx.domains.c.CObject
- Description of a C language object.sphinx.domains.c.CEnumeratorObject
- Undocumentedsphinx.domains.c.CEnumObject
- Undocumentedsphinx.domains.c.CFunctionObject
- Undocumentedsphinx.domains.c.CMacroObject
- Undocumentedsphinx.domains.c.CMemberObject
- Undocumentedsphinx.domains.c.CStructObject
- Undocumentedsphinx.domains.c.CTypeObject
- Undocumentedsphinx.domains.c.CUnionObject
- Undocumentedsphinx.domains.cpp.CPPAliasObject
- No class docstring; 0/3 instance variable, 0/1 class variable, 1/1 method documentedsphinx.domains.cpp.CPPObject
- Description of a C++ language object.sphinx.domains.cpp.CPPClassObject
- Undocumentedsphinx.domains.cpp.CPPConceptObject
- Undocumentedsphinx.domains.cpp.CPPEnumeratorObject
- Undocumentedsphinx.domains.cpp.CPPEnumObject
- Undocumentedsphinx.domains.cpp.CPPFunctionObject
- Undocumentedsphinx.domains.cpp.CPPMemberObject
- Undocumentedsphinx.domains.cpp.CPPTypeObject
- Undocumentedsphinx.domains.cpp.CPPUnionObject
- Undocumentedsphinx.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.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
- Undocumentedsphinx.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
- Undocumentedsphinx.domains.c.CNamespaceObject
- This directive is just to tell Sphinx that we're documenting stuff in namespace foo.sphinx.domains.c.CNamespacePopObject
- Undocumentedsphinx.domains.c.CNamespacePushObject
- Undocumentedsphinx.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
- Undocumentedsphinx.domains.cpp.CPPNamespacePushObject
- Undocumentedsphinx.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
- Undocumentedsphinx.ext.doctest.TestcleanupDirective
- Undocumentedsphinx.ext.doctest.TestcodeDirective
- Undocumentedsphinx.ext.doctest.TestoutputDirective
- Undocumentedsphinx.ext.doctest.TestsetupDirective
- Undocumentedsphinx.ext.graphviz.Graphviz
- Directive to insert arbitrary dot markup.sphinx.ext.graphviz.GraphvizSimple
- Directive to insert arbitrary dot markup.sphinx.ext.ifconfig.IfConfig
- Undocumentedsphinx.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.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.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
- Undocumentedsphinx.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
- Undocumentedsphinx.transforms.ApplySourceWorkaround
- Update source and rawsource attributessphinx.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 nodesphinx.transforms.DoctreeReadEvent
- Emit :event:`doctree-read` event.sphinx.transforms.ExtraTranslatableNodes
- Make nodes translatablesphinx.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 translationsphinx.transforms.i18n.RemoveTranslatableInline
- Remove inline nodes used for translation as placeholders.sphinx.transforms.ManpageLink
- Find manpage section numbers and namessphinx.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
- Undocumentedsphinx.transforms.post_transforms.images.DataURIExtractor
- Undocumentedsphinx.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 documentedsphinx.transforms.post_transforms.images.ImageDownloader
- Undocumentedsphinx.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`` nodes from doctrees.sphinx.builders.linkcheck.HyperlinkCollector
- Undocumentedsphinx.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
- Undocumentedsphinx.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 warningssphinx.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 documentedsphinx.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 documentedsphinx.writers.xml.XMLWriter
- Undocumenteddocutils.writers.html4css1.HTMLTranslator
sphinx.writers._html4.HTML4Translator
- Our custom HTML translator.docutils.writers.html4css1.Writer
sphinx.writers.html.HTMLWriter
- Undocumenteddocutils.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 documenteddocutils.writers.manpage.Translator
sphinx.writers.manpage.ManualPageTranslator
- Custom man page translator.docutils.writers.manpage.Writer
sphinx.writers.manpage.ManualPageWriter
- Undocumenteddocutils.writers.UnfilteredWriter
sphinx.io.SphinxDummyWriter
- Dummy writer module used for generating doctree.docutils.writers.Writer
sphinx.writers.latex.LaTeXWriter
- Undocumentedsphinx.writers.texinfo.TexinfoWriter
- Texinfo writer for generating Texinfo documents.sphinx.writers.text.TextWriter
- Undocumentedenum.IntEnum
sphinx.util.build_phase.BuildPhase
- Build phase of Sphinx application.Exception
sphinx.cmd.quickstart.ValidationError
- Raised for validation errors.sphinx.domains.c._DuplicateSymbolError
- Undocumentedsphinx.domains.cpp._DuplicateSymbolError
- Undocumentedsphinx.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
- Undocumentedsphinx.ext.imgmath.InvokeError
- errors on invoking converters.sphinx.ext.imgmath.MathExtError
- Undocumentedsphinx.ext.linkcode.LinkcodeError
- Undocumentedsphinx.writers.latex.UnsupportedError
- Undocumentedsphinx.ext.autosummary.ImportExceptionGroup
- Exceptions raised during importing the target objects.sphinx.ext.inheritance_diagram.InheritanceException
- Undocumentedsphinx.util.cfamily.DefinitionError
- Undocumentedsphinx.util.cfamily.NoOldIdError
- Undocumentedsphinx.util.cfamily.UnsupportedMultiCharacterCharLiteral
- Undocumentedsphinx.util.display.SkipProgressMessage
- Undocumentedsphinx.util.docutils.ElementLookupError
- Undocumentedhtml.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 inheritancejinja2.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 expectssphinx.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
- Undocumentedlogging.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 locationsphinx.util.logging.SphinxInfoLogRecord
- Info log record class supporting locationsphinx.util.logging.SphinxWarningLogRecord
- Warning log record class supporting locationlogging.StreamHandler
sphinx.util.logging.NewLineStreamHandler
- StreamHandler which switches line terminator by record.nonl flag.sphinx.util.logging.WarningStreamHandler
- StreamHandler for warnings.PendingDeprecationWarning
sphinx.deprecation.RemovedInSphinx80Warning
- Undocumentedpygments.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.setuptools.Command
sphinx.setup_command.BuildDoc
- Distutils command to build Sphinx documentation.sphinx.addnodes.not_smartquotable
- A node which does not support smart-quotes.sphinx.addnodes._desc_classes_injector
- Helper base class for injecting a fixed 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 :class:`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
- Undocumentedsphinx.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
- Undocumentedsphinx.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.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
- Undocumentedsphinx.cmd.make_mode.Make
- Undocumentedsphinx.config.Config
- Configuration file abstraction.sphinx.config.ENUM
- Represents the candidates which a config value should be one of.sphinx.deprecation._ModuleWrapper
- Undocumentedsphinx.directives.code.LiteralIncludeReader
- Undocumentedsphinx.domains.c.LookupKey
- Undocumentedsphinx.domains.c.Symbol
- Undocumentedsphinx.domains.c.SymbolLookupResult
- Undocumentedsphinx.domains.cpp.LookupKey
- Undocumentedsphinx.domains.cpp.Symbol
- Undocumentedsphinx.domains.cpp.SymbolLookupResult
- Undocumentedsphinx.domains.Domain
- A Domain is meant to be a group of "object" description directives for objects of a similar nature, and corresponding roles to create references to them. Examples would be Python modules, classes, functions etc...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
- Undocumentedsphinx.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.PyXrefMixin
- Undocumentedsphinx.domains.python.PyField
- Undocumentedsphinx.domains.python.PyGroupedField
- Undocumentedsphinx.domains.python.PyTypedField
- Undocumentedsphinx.environment.adapters.asset.ImageAdapter
- No class docstring; 0/1 instance variable, 1/2 method documentedsphinx.environment.adapters.indexentries.IndexEntries
- No class docstring; 0/1 instance variable, 1/2 method documentedsphinx.environment.adapters.toctree.TocTree
- No class docstring; 0/1 instance variable, 0/1 type variable, 5/7 methods documentedsphinx.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 documentedsphinx.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 documentedsphinx.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.DataDocumenter
- Specialized Documenter subclass for data items.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.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.SlotsMixin
- Mixin for AttributeDocumenter to provide the feature for supporting __slots__.sphinx.ext.autodoc.AttributeDocumenter
- Specialized Documenter subclass for attributes.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.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.directive.DocumenterBridge
- A parameters container for Documenters.sphinx.ext.autosummary.FakeDirective
- Undocumentedsphinx.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.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.MethodDocumenter
- Specialized Documenter subclass for methods (normal, static and class).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.MethodDocumenter
- Specialized Documenter subclass for methods (normal, static and class).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.FunctionDocumenter
- Specialized Documenter subclass for functions.sphinx.ext.autodoc.DecoratorDocumenter
- Specialized Documenter subclass for decorator functions.sphinx.ext.autodoc.mock._MockObject
- Used by autodoc_mock_imports.sphinx.ext.autodoc.preserve_defaults.DefaultValue
- Undocumentedsphinx.ext.autosummary.FakeApplication
- Undocumentedsphinx.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
- Undocumentedsphinx.ext.doctest.TestCode
- Undocumentedsphinx.ext.doctest.TestGroup
- Undocumentedsphinx.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 environmentsphinx.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 documentedsphinx.extension.Extension
- Undocumentedsphinx.highlighting.PygmentsBridge
- Undocumentedsphinx.jinja2glue.idgen
- Undocumentedsphinx.locale._TranslationProxy
- Class for proxy strings from gettext translations. This is a helper for the lazy_* functions from this module.sphinx.project.Project
- A project is the source code set of the Sphinx document(s).sphinx.pycode.ModuleAnalyzer
- No class docstring; 0/10 instance variable, 0/1 class variable, 3/4 methods, 1/1 static method, 0/4 class method documentedsphinx.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 documentedsphinx.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 documentedsphinx.roles.SphinxRole
sphinx.domains.c.CExprRole
- Undocumentedsphinx.domains.cpp.CPPExprRole
- Undocumentedsphinx.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 documentedsphinx.search.ja.DefaultSplitter
- Undocumentedsphinx.search.ja.JanomeSplitter
- Undocumentedsphinx.search.ja.MecabSplitter
- Undocumentedsphinx.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
- Undocumentedsphinx.search.de.SearchGerman
- Undocumentedsphinx.search.en.SearchEnglish
- Undocumentedsphinx.search.es.SearchSpanish
- Undocumentedsphinx.search.fi.SearchFinnish
- Undocumentedsphinx.search.fr.SearchFrench
- Undocumentedsphinx.search.hu.SearchHungarian
- Undocumentedsphinx.search.it.SearchItalian
- Undocumentedsphinx.search.ja.SearchJapanese
- Japanese search implementation: uses no stemmer, but word splitting is quite complicated.sphinx.search.nl.SearchDutch
- Undocumentedsphinx.search.no.SearchNorwegian
- Undocumentedsphinx.search.pt.SearchPortuguese
- Undocumentedsphinx.search.ro.SearchRomanian
- Undocumentedsphinx.search.ru.SearchRussian
- Undocumentedsphinx.search.sv.SearchSwedish
- Undocumentedsphinx.search.tr.SearchTurkish
- Undocumentedsphinx.search.zh.SearchChinese
- Chinese search implementationsphinx.search.WordStore
- Undocumentedsphinx.testing.comparer.PathComparer
- OS-independent path comparison.sphinx.testing.fixtures.SharedResult
- Undocumentedsphinx.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
- Undocumentedsphinx.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
- Undocumentedsphinx.domains.c.ASTBase
- Undocumentedsphinx.domains.c.ASTArray
- Undocumentedsphinx.domains.c.ASTBinOpExpr
- Undocumentedsphinx.domains.c.ASTBracedInitList
- Undocumentedsphinx.domains.c.ASTDeclarator
- Undocumentedsphinx.domains.c.ASTDeclaratorNameBitField
- Undocumentedsphinx.domains.c.ASTDeclaratorNameParam
- Undocumentedsphinx.domains.c.ASTDeclaratorParen
- Undocumentedsphinx.domains.c.ASTDeclaratorPtr
- Undocumentedsphinx.domains.c.ASTDeclSpecs
- Undocumentedsphinx.domains.c.ASTEnum
- Undocumentedsphinx.domains.c.ASTEnumerator
- Undocumentedsphinx.domains.c.ASTExpression
- Undocumentedsphinx.domains.c.ASTAlignofExpr
- Undocumentedsphinx.domains.c.ASTAssignmentExpr
- Undocumentedsphinx.domains.c.ASTCastExpr
- Undocumentedsphinx.domains.c.ASTFallbackExpr
- Undocumentedsphinx.domains.c.ASTIdExpression
- Undocumentedsphinx.domains.c.ASTLiteral
- Undocumentedsphinx.domains.c.ASTBooleanLiteral
- Undocumentedsphinx.domains.c.ASTCharLiteral
- Undocumentedsphinx.domains.c.ASTNumberLiteral
- Undocumentedsphinx.domains.c.ASTStringLiteral
- Undocumentedsphinx.domains.c.ASTParenExpr
- Undocumentedsphinx.domains.c.ASTPostfixExpr
- Undocumentedsphinx.domains.c.ASTSizeofExpr
- Undocumentedsphinx.domains.c.ASTSizeofType
- Undocumentedsphinx.domains.c.ASTUnaryOpExpr
- Undocumentedsphinx.domains.c.ASTFunctionParameter
- Undocumentedsphinx.domains.c.ASTInitializer
- Undocumentedsphinx.domains.c.ASTMacro
- Undocumentedsphinx.domains.c.ASTMacroParameter
- Undocumentedsphinx.domains.c.ASTNestedName
- Undocumentedsphinx.domains.c.ASTParameters
- Undocumentedsphinx.domains.c.ASTPostfixOp
- Undocumentedsphinx.domains.c.ASTPostfixArray
- Undocumentedsphinx.domains.c.ASTPostfixCallExpr
- Undocumentedsphinx.domains.c.ASTPostfixDec
- Undocumentedsphinx.domains.c.ASTPostfixInc
- Undocumentedsphinx.domains.c.ASTPostfixMemberOfPointer
- Undocumentedsphinx.domains.c.ASTStruct
- Undocumentedsphinx.domains.c.ASTTrailingTypeSpec
- Undocumentedsphinx.domains.c.ASTTrailingTypeSpecFundamental
- Undocumentedsphinx.domains.c.ASTTrailingTypeSpecName
- Undocumentedsphinx.domains.c.ASTType
- Undocumentedsphinx.domains.c.ASTTypeWithInit
- Undocumentedsphinx.domains.c.ASTUnion
- Undocumentedsphinx.domains.c.ASTDeclaration
- Undocumentedsphinx.domains.c.ASTDeclSpecsSimple
- Undocumentedsphinx.domains.c.ASTIdentifier
- Undocumentedsphinx.domains.cpp.ASTBase
- Undocumentedsphinx.domains.cpp.ASTArray
- Undocumentedsphinx.domains.cpp.ASTBaseClass
- Undocumentedsphinx.domains.cpp.ASTBracedInitList
- Undocumentedsphinx.domains.cpp.ASTClass
- Undocumentedsphinx.domains.cpp.ASTConcept
- Undocumentedsphinx.domains.cpp.ASTDeclaration
- Undocumentedsphinx.domains.cpp.ASTDeclarator
- Undocumentedsphinx.domains.cpp.ASTDeclaratorMemPtr
- Undocumentedsphinx.domains.cpp.ASTDeclaratorNameBitField
- Undocumentedsphinx.domains.cpp.ASTDeclaratorNameParamQual
- Undocumentedsphinx.domains.cpp.ASTDeclaratorParamPack
- Undocumentedsphinx.domains.cpp.ASTDeclaratorParen
- Undocumentedsphinx.domains.cpp.ASTDeclaratorPtr
- Undocumentedsphinx.domains.cpp.ASTDeclaratorRef
- Undocumentedsphinx.domains.cpp.ASTDeclSpecs
- Undocumentedsphinx.domains.cpp.ASTDeclSpecsSimple
- Undocumentedsphinx.domains.cpp.ASTEnum
- Undocumentedsphinx.domains.cpp.ASTEnumerator
- Undocumentedsphinx.domains.cpp.ASTExplicitSpec
- Undocumentedsphinx.domains.cpp.ASTExpression
- Undocumentedsphinx.domains.cpp.ASTAlignofExpr
- Undocumentedsphinx.domains.cpp.ASTAssignmentExpr
- Undocumentedsphinx.domains.cpp.ASTBinOpExpr
- Undocumentedsphinx.domains.cpp.ASTCastExpr
- Undocumentedsphinx.domains.cpp.ASTCommaExpr
- Undocumentedsphinx.domains.cpp.ASTConditionalExpr
- Undocumentedsphinx.domains.cpp.ASTDeleteExpr
- Undocumentedsphinx.domains.cpp.ASTExplicitCast
- Undocumentedsphinx.domains.cpp.ASTFallbackExpr
- Undocumentedsphinx.domains.cpp.ASTFoldExpr
- Undocumentedsphinx.domains.cpp.ASTIdExpression
- Undocumentedsphinx.domains.cpp.ASTLiteral
- Undocumentedsphinx.domains.cpp.ASTBooleanLiteral
- Undocumentedsphinx.domains.cpp.ASTCharLiteral
- Undocumentedsphinx.domains.cpp.ASTNumberLiteral
- Undocumentedsphinx.domains.cpp.ASTPointerLiteral
- Undocumentedsphinx.domains.cpp.ASTStringLiteral
- Undocumentedsphinx.domains.cpp.ASTUserDefinedLiteral
- Undocumentedsphinx.domains.cpp.ASTNewExpr
- Undocumentedsphinx.domains.cpp.ASTNoexceptExpr
- Undocumentedsphinx.domains.cpp.ASTPackExpansionExpr
- Undocumentedsphinx.domains.cpp.ASTParenExpr
- Undocumentedsphinx.domains.cpp.ASTPostfixExpr
- Undocumentedsphinx.domains.cpp.ASTSizeofExpr
- Undocumentedsphinx.domains.cpp.ASTSizeofParamPack
- Undocumentedsphinx.domains.cpp.ASTSizeofType
- Undocumentedsphinx.domains.cpp.ASTThisLiteral
- Undocumentedsphinx.domains.cpp.ASTTypeId
- Undocumentedsphinx.domains.cpp.ASTUnaryOpExpr
- Undocumentedsphinx.domains.cpp.ASTFunctionParameter
- Undocumentedsphinx.domains.cpp.ASTIdentifier
- Undocumentedsphinx.domains.cpp.ASTInitializer
- Undocumentedsphinx.domains.cpp.ASTNamespace
- Undocumentedsphinx.domains.cpp.ASTNestedName
- Undocumentedsphinx.domains.cpp.ASTNestedNameElement
- Undocumentedsphinx.domains.cpp.ASTNoexceptSpec
- Undocumentedsphinx.domains.cpp.ASTOperator
- No class docstring; 1/5 method documentedsphinx.domains.cpp.ASTOperatorBuildIn
- Undocumentedsphinx.domains.cpp.ASTOperatorLiteral
- Undocumentedsphinx.domains.cpp.ASTOperatorType
- Undocumentedsphinx.domains.cpp.ASTParametersQualifiers
- Undocumentedsphinx.domains.cpp.ASTPostfixOp
- Undocumentedsphinx.domains.cpp.ASTPostfixArray
- Undocumentedsphinx.domains.cpp.ASTPostfixCallExpr
- Undocumentedsphinx.domains.cpp.ASTPostfixDec
- Undocumentedsphinx.domains.cpp.ASTPostfixInc
- Undocumentedsphinx.domains.cpp.ASTPostfixMember
- Undocumentedsphinx.domains.cpp.ASTPostfixMemberOfPointer
- Undocumentedsphinx.domains.cpp.ASTRequiresClause
- Undocumentedsphinx.domains.cpp.ASTTemplateArgConstant
- Undocumentedsphinx.domains.cpp.ASTTemplateArgs
- Undocumentedsphinx.domains.cpp.ASTTemplateDeclarationPrefix
- Undocumentedsphinx.domains.cpp.ASTTemplateIntroduction
- Undocumentedsphinx.domains.cpp.ASTTemplateIntroductionParameter
- Undocumentedsphinx.domains.cpp.ASTTemplateParam
- Undocumentedsphinx.domains.cpp.ASTTemplateKeyParamPackIdDefault
- Undocumentedsphinx.domains.cpp.ASTTemplateParamNonType
- Undocumentedsphinx.domains.cpp.ASTTemplateParamTemplateType
- Undocumentedsphinx.domains.cpp.ASTTemplateParamType
- Undocumentedsphinx.domains.cpp.ASTTemplateParamConstrainedTypeWithInit
- Undocumentedsphinx.domains.cpp.ASTTemplateParams
- Undocumentedsphinx.domains.cpp.ASTTrailingTypeSpec
- Undocumentedsphinx.domains.cpp.ASTTrailingTypeSpecDecltype
- Undocumentedsphinx.domains.cpp.ASTTrailingTypeSpecDecltypeAuto
- Undocumentedsphinx.domains.cpp.ASTTrailingTypeSpecFundamental
- Undocumentedsphinx.domains.cpp.ASTTrailingTypeSpecName
- Undocumentedsphinx.domains.cpp.ASTType
- Undocumentedsphinx.domains.cpp.ASTTypeUsing
- Undocumentedsphinx.domains.cpp.ASTTypeWithInit
- Undocumentedsphinx.domains.cpp.ASTUnion
- Undocumentedsphinx.util.cfamily.ASTAttribute
- Undocumentedsphinx.util.cfamily.ASTCPPAttribute
- Undocumentedsphinx.util.cfamily.ASTGnuAttributeList
- Undocumentedsphinx.util.cfamily.ASTIdAttribute
- For simple attributes defined by the user.sphinx.util.cfamily.ASTParenAttribute
- For paren attributes defined by the user.sphinx.util.cfamily.ASTAttributeList
- Undocumentedsphinx.util.cfamily.ASTBaseParenExprList
- Undocumentedsphinx.domains.c.ASTParenExprList
- Undocumentedsphinx.domains.cpp.ASTParenExprList
- Undocumentedsphinx.util.cfamily.ASTGnuAttribute
- Undocumentedsphinx.util.cfamily.BaseParser
- Undocumentedsphinx.domains.c.DefinitionParser
- No class docstring; 0/3 property, 2/37 methods documentedsphinx.domains.cpp.DefinitionParser
- No class docstring; 0/3 property, 0/1 instance variable, 2/47 methods documentedsphinx.util.display.progress_message
- Undocumentedsphinx.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
- Undocumentedsphinx.util.docfields.GroupedField
- A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list. It always has an argument. The argument can be linked using the given *rolename*...sphinx.domains.python.PyGroupedField
- Undocumentedsphinx.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
- Undocumentedsphinx.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
- Undocumentedsphinx.roles.Abbreviation
- Undocumentedsphinx.roles.EmphasizedLiteral
- Undocumentedsphinx.roles.GUILabel
- Undocumentedsphinx.roles.MenuSelection
- Undocumentedsphinx.util.docutils.ReferenceRole
- A base class for reference roles.sphinx.domains.index.IndexRole
- Undocumentedsphinx.roles.PEP
- Undocumentedsphinx.roles.RFC
- Undocumentedsphinx.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
- Undocumentedsphinx.domains.cpp.CPPXRefRole
- Undocumentedsphinx.domains.javascript.JSXRefRole
- Undocumentedsphinx.domains.math.MathReferenceRole
- Undocumentedsphinx.domains.python.PyXRefRole
- Undocumentedsphinx.domains.std.EnvVarXRefRole
- Cross-referencing role for environment variables (adds an index entry).sphinx.domains.std.OptionXRefRole
- Undocumentedsphinx.domains.std.TokenXRefRole
- Undocumentedsphinx.roles.AnyXRefRole
- Undocumentedsphinx.util.docutils.WarningStream
- Undocumentedsphinx.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
- Undocumentedsphinx.util.inventory.InventoryFileReader
- A file reader for an inventory file.sphinx.util.logging.LastMessagesWriter
- Stream writer storing last 10 messages in memory to save trackbacksphinx.util.logging.LogCollector
- Undocumentedsphinx.util.logging.SafeEncodingWriter
- Stream writer which ignores UnicodeEncodeError silentlysphinx.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.stemmer.BaseStemmer
- Undocumentedsphinx.util.stemmer.PyStemmer
- Undocumentedsphinx.util.stemmer.StandardStemmer
- Undocumentedsphinx.util.stemmer.PorterStemmer
- Undocumentedsphinx.util.tags.Tags
- Undocumentedsphinx.builders.gettext.I18nTags
- Dummy tags module for I18nBuilder.sphinx.util.Tee
- File-like object writing to two streams.sphinx.util.template.BaseRenderer
- Undocumentedsphinx.util.template.FileRenderer
- Undocumentedsphinx.util.template.SphinxRenderer
- Undocumentedsphinx.builders.gettext.GettextRenderer
- Undocumentedsphinx.cmd.quickstart.QuickstartRenderer
- No class docstring; 0/1 instance variable, 1/3 method documentedsphinx.util.template.LaTeXRenderer
- Undocumentedsphinx.util.template.ReSTRenderer
- Undocumentedsphinx.util.UnicodeDecodeErrorHandler
- Custom error handler for open() that warns and replaces.sphinx.writers.latex.Table
- A table datasphinx.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.Dict
sphinx.deprecation.DeprecatedDict
- A deprecated dict which warns on each access.sphinx.util.inspect.TypeAliasNamespace
- Pseudo namespace class for autodoc_type_aliases.typing.Generic
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 documentedsphinx.domains.c.CObject
- Description of a C language object.sphinx.domains.c.CEnumeratorObject
- Undocumentedsphinx.domains.c.CEnumObject
- Undocumentedsphinx.domains.c.CFunctionObject
- Undocumentedsphinx.domains.c.CMacroObject
- Undocumentedsphinx.domains.c.CMemberObject
- Undocumentedsphinx.domains.c.CStructObject
- Undocumentedsphinx.domains.c.CTypeObject
- Undocumentedsphinx.domains.c.CUnionObject
- Undocumentedsphinx.domains.cpp.CPPAliasObject
- No class docstring; 0/3 instance variable, 0/1 class variable, 1/1 method documentedsphinx.domains.cpp.CPPObject
- Description of a C++ language object.sphinx.domains.cpp.CPPClassObject
- Undocumentedsphinx.domains.cpp.CPPConceptObject
- Undocumentedsphinx.domains.cpp.CPPEnumeratorObject
- Undocumentedsphinx.domains.cpp.CPPEnumObject
- Undocumentedsphinx.domains.cpp.CPPFunctionObject
- Undocumentedsphinx.domains.cpp.CPPMemberObject
- Undocumentedsphinx.domains.cpp.CPPTypeObject
- Undocumentedsphinx.domains.cpp.CPPUnionObject
- Undocumentedsphinx.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.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
- Undocumentedtyping.MutableMapping
sphinx.environment._DomainsType
- Undocumentedtyping.NamedTuple
sphinx.builders._epub_base.Guide
- Undocumentedsphinx.builders._epub_base.ManifestItem
- Undocumentedsphinx.builders._epub_base.NavPoint
- Undocumentedsphinx.builders._epub_base.Spine
- Undocumentedsphinx.builders.epub3.NavPoint
- Undocumentedsphinx.builders.linkcheck.CheckRequest
- Undocumentedsphinx.builders.linkcheck.CheckResult
- Undocumentedsphinx.builders.linkcheck.Hyperlink
- Undocumentedsphinx.builders.linkcheck.RateLimit
- Undocumentedsphinx.config.ConfigValue
- Undocumentedsphinx.domains.changeset.ChangeSet
- Undocumentedsphinx.domains.IndexEntry
- Undocumentedsphinx.domains.python.ModuleEntry
- Undocumentedsphinx.domains.python.ObjectEntry
- Undocumentedsphinx.events.EventListener
- Undocumentedsphinx.ext.autodoc.importer.Attribute
- Undocumentedsphinx.ext.autosummary.generate.AutosummaryEntry
- Undocumentedsphinx.transforms.post_transforms.code.HighlightSetting
- Undocumentedsphinx.util.i18n.LocaleFileInfoBase
- Undocumentedsphinx.util.i18n.CatalogInfo
- Undocumentedsphinx.util.images.DataURI
- Undocumented