sphinx.addnodes

module documentation
(source)

Document tree nodes that Sphinx defines on top of those in Docutils.

Class acks Special node for "acks" lists.
Class centered This node is deprecated.
Class compact_paragraph Node for a compact paragraph (which never makes a <p> node).
Class desc Node for a list of object signatures and a common description of them.
Class desc_addname Node for additional name parts for an object.
Class desc_annotation Node for signature annotations (not Python 3-style annotations).
Class desc_content Node for object description content.
Class desc_inline Node for a signature fragment in inline text.
Class desc_name Node for the main object name.
Class desc_optional Node for marking optional parts of the parameter list.
Class desc_parameter Node for a single parameter.
Class desc_parameterlist Node for a general parameter list.
Class desc_returns Node for a "returns" annotation (a la -> in Python).
Class desc_sig_element Common parent class of nodes for inline text of a signature.
Class desc_sig_keyword Node for a general keyword in a signature.
Class desc_sig_keyword_type Node for a keyword which is a built-in type in a signature.
Class desc_sig_literal_char Node for a character literal in a signature.
Class desc_sig_literal_number Node for a numeric literal in a signature.
Class desc_sig_literal_string Node for a string literal in a signature.
Class desc_sig_name Node for an identifier in a signature.
Class desc_sig_operator Node for an operator in a signature.
Class desc_sig_punctuation Node for punctuation in a signature.
Class desc_sig_space Node for a space in a signature.
Class desc_signature Node for a single object signature.
Class desc_signature_line Node for a line in a multi-line object signature.
Class desc_type Node for return types or object type names.
Class document The document root element patched by Sphinx.
Class download_reference Node for download references, similar to pending_xref.
Class glossary Node to insert a glossary.
Class highlightlang Inserted to set the highlight language and line number options for subsequent code blocks.
Class hlist Node for "horizontal lists", i.e. lists that should be compressed to take up less vertical space.
Class hlistcol Node for one column in a horizontal list.
Class index Node for index entries.
Class literal_emphasis Node that behaves like `emphasis`, but further text processors are not applied (e.g. smartypants for HTML output).
Class literal_strong Node that behaves like `strong`, but further text processors are not applied (e.g. smartypants for HTML output).
Class manpage Node for references to manpages.
Class not_smartquotable A node which does not support smart-quotes.
Class number_reference Node for number references, similar to pending_xref.
Class only Node for "only" directives (conditional inclusion based on tags).
Class pending_xref Node for cross-references that cannot be resolved without complete information about all documents.
Class pending_xref_condition Node representing a potential way to create a cross-reference and the condition in which this way should be used.
Class production Node for a single grammar production rule.
Class productionlist Node for grammar production lists.
Class seealso Custom "see also" admonition.
Class start_of_file Node to mark start of a new file, used in the LaTeX builder only.
Class tabular_col_spec Node for specifying tabular columns, used for LaTeX output.
Class toctree Node for inserting a "TOC tree".
Class translatable Node which supports translation.
Class versionmodified Node for version change entries.
Function setup Undocumented
Constant SIG_ELEMENTS Undocumented
Class _desc_classes_injector Helper base class for injecting a fixed list of classes.
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
SIG_ELEMENTS = (source)

Undocumented

Value
[desc_sig_space,
 desc_sig_name,
 desc_sig_operator,
 desc_sig_punctuation,
 desc_sig_keyword,
 desc_sig_keyword_type,
 desc_sig_literal_number,
...