Node for object descriptions.
This node is similar to a “definition list” with one definition. It contains one or more desc_signature and a desc_content.
Node for object signatures.
The “term” part of the custom Sphinx definition list.
Node for additional name parts (module name, class name).
Node for return types or object type names.
Node for a “returns” annotation (a la -> in Python).
Node for the main object name.
Node for a general parameter list.
Node for a single parameter.
Node for marking optional parts of the parameter list.
Node for signature annotations (not Python 3-style annotations).
Node for object description content.
This is the “definition” part of the custom Sphinx definition list.
Node for version change entries.
Currently used for “versionadded”, “versionchanged” and “deprecated” directives.
Custom “see also” admonition.
Node for a compact paragraph (which never makes a <p> node).
Node for index entries.
This node is created by the index directive and has one attribute, entries. Its value is a list of 4-tuples of (entrytype, entryname, target, ignored).
entrytype is one of “single”, “pair”, “double”, “triple”.
Node for cross-references that cannot be resolved without complete information about all documents.
These nodes are resolved before writing output, in BuildEnvironment.resolve_references.
Node that behaves like emphasis, but further text processors are not applied (e.g. smartypants for HTML output).
Node for abbreviations with explanations.
Node for download references, similar to pending_xref.
Node for “only” directives (conditional inclusion based on tags).
Node for meta directive – same as docutils’ standard meta node, but pickleable.
Inserted to set the highlight language and line number options for subsequent code blocks.
You should not need to generate the nodes below in extensions.
Node to insert a glossary.
Node for inserting a “TOC tree”.
Node to mark start of a new file, used in the LaTeX builder only.
Node for grammar production lists.
Contains production nodes.
Node for a single grammar production rule.
Separates two terms within a <term> node.