sphinx.domains.rst.ReSTMarkup

class documentation

class ReSTMarkup(ObjectDescription[str]): (source)

Known subclasses: sphinx.domains.rst.ReSTDirective, sphinx.domains.rst.ReSTDirectiveOption, sphinx.domains.rst.ReSTRole

View In Hierarchy

Description of generic reST markup.

Method	`add_target_and_index`	Add cross-reference IDs and entries to self.indexnode, if applicable.
Method	`get_index_text`	Undocumented
Method	`make_old_id`	Generate old styled node_id for reST markups.
Class Variable	`option_spec`	Undocumented
Method	`_object_hierarchy_parts`	Returns a tuple of strings, one entry for each part of the object's hierarchy (e.g. ``('module', 'submodule', 'Class', 'method')``). The returned tuple is used to properly nest children within parents in the table of contents, and can also be used within the :py:meth:`_toc_entry_name` method.
Method	`_toc_entry_name`	Returns the text of the table of contents entry for the object.

Inherited from ObjectDescription:

Method	`after_content`	Called after parsing content. Used to reset information about the current directive context on the build environment.
Method	`before_content`	Called before parsing content. Used to set information about the current directive context on the build environment.
Method	`get_field_type_map`	Undocumented
Method	`get_signatures`	Retrieve the signatures to document from the directive arguments. By default, signatures are given as arguments, one per line.
Method	`handle_signature`	Parse the signature sig into individual nodes and append them to signode. If ValueError is raised, parsing is aborted and the whole sig is put into a single desc_name node.
Method	`run`	Main directive entry function, called by docutils upon encountering the directive.
Method	`transform_content`	Called after creating the content through nested parsing, but before the ``object-description-transform`` event is emitted, and before the info-fields are transformed. Can be used to manipulate the content.
Class Variable	`doc_field_types`	Undocumented
Class Variable	`final_argument_whitespace`	Undocumented
Class Variable	`has_content`	Undocumented
Class Variable	`optional_arguments`	Undocumented
Class Variable	`required_arguments`	Undocumented
Instance Variable	`domain`	Undocumented
Instance Variable	`indexnode`	Undocumented
Instance Variable	`names`	Undocumented
Instance Variable	`objtype`	Undocumented
Instance Variable	`_doc_field_type_map`	Undocumented

Inherited from SphinxDirective (via ObjectDescription):

Method	`get_location`	Get current location info for logging.
Method	`get_source_info`	Get source and line number.
Method	`set_source_info`	Set source and line number to the node.
Property	`config`	Reference to the :class:`.Config` object.
Property	`env`	Reference to the :class:`.BuildEnvironment` object.

def add_target_and_index(self, name, sig, signode): (source) ¶

overrides sphinx.directives.ObjectDescription.add_target_and_index

overridden in sphinx.domains.rst.ReSTDirectiveOption

Add cross-reference IDs and entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.

Parameters
name:`str`	Undocumented
sig:`str`	Undocumented
signode:`desc_signature`	Undocumented

def get_index_text(self, objectname, name): (source) ¶

overridden in sphinx.domains.rst.ReSTDirective, sphinx.domains.rst.ReSTRole

Undocumented

Parameters
objectname:`str`	Undocumented
name:`str`	Undocumented
Returns
`str`	Undocumented

def make_old_id(self, name): (source) ¶

overridden in sphinx.domains.rst.ReSTDirectiveOption

Generate old styled node_id for reST markups. .. note:: Old Styled node_id was used until Sphinx-3.0. This will be removed in Sphinx-5.0.

Parameters
name:`str`	Undocumented
Returns
`str`	Undocumented

option_spec: OptionSpec = (source) ¶

overrides sphinx.directives.ObjectDescription.option_spec

overridden in sphinx.domains.rst.ReSTDirectiveOption

Undocumented

def _object_hierarchy_parts(self, sig_node): (source) ¶

overrides sphinx.directives.ObjectDescription._object_hierarchy_parts

Returns a tuple of strings, one entry for each part of the object's hierarchy (e.g. ``('module', 'submodule', 'Class', 'method')``). The returned tuple is used to properly nest children within parents in the table of contents, and can also be used within the :py:meth:`_toc_entry_name` method. This method must not be used outwith table of contents generation.

Parameters
sig_node:`desc_signature`	Undocumented
Returns
`tuple[str, ...]`	Undocumented

def _toc_entry_name(self, sig_node): (source) ¶

overrides sphinx.directives.ObjectDescription._toc_entry_name

Returns the text of the table of contents entry for the object. This function is called once, in :py:meth:`run`, to set the name for the table of contents entry (a special attribute ``_toc_name`` is set on the object node, later used in ``environment.collectors.toctree.TocTreeCollector.process_doc().build_toc()`` when the table of contents entries are collected). To support table of contents entries for their objects, domains must override this method, also respecting the configuration setting ``toc_object_entries_show_parents``. Domains must also override :py:meth:`_object_hierarchy_parts`, with one (string) entry for each part of the object's hierarchy. The result of this method is set on the signature node, and can be accessed as ``sig_node['_toc_parts']`` for use within this method. The resulting tuple is also used to properly nest children within parents in the table of contents. An example implementations of this method is within the python domain (:meth:`PyObject._toc_entry_name`). The python domain sets the ``_toc_parts`` attribute within the :py:meth:`handle_signature()` method.

Parameters
sig_node:`desc_signature`	Undocumented
Returns
`str`	Undocumented