sphinx.domains.rst.ReSTMarkup

class documentation

class ReSTMarkup(ObjectDescription[str]):

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 Undocumented
Method get​_index​_text Undocumented
Method make​_old​_id Generate old styled node_id for reST markups.
def add_target_and_index(self, name, sig, signode):
overridden in sphinx.domains.rst.ReSTDirectiveOption

Undocumented

Parameters
name:strUndocumented
sig:strUndocumented
signode:desc_signatureUndocumented
def get_index_text(self, objectname, name):
overridden in sphinx.domains.rst.ReSTDirective, sphinx.domains.rst.ReSTRole

Undocumented

Parameters
objectname:strUndocumented
name:strUndocumented
Returns
strUndocumented
def make_old_id(self, name):
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:strUndocumented
Returns
strUndocumented