sphinx.domains.rst.ReSTRole

class documentation

class ReSTRole(ReSTMarkup):

View In Hierarchy

Description of a reST role.
Method get​_index​_text Undocumented
Method handle​_signature Undocumented

Inherited from ReSTMarkup:

Method add​_target​_and​_index Undocumented
Method make​_old​_id Generate old styled node_id for reST markups.
def get_index_text(self, objectname, name):
overrides sphinx.domains.rst.ReSTMarkup.get_index_text

Undocumented

Parameters
objectname:strUndocumented
name:strUndocumented
Returns
strUndocumented
def handle_signature(self, sig, signode):

Undocumented

Parameters
sig:strUndocumented
signode:desc_signatureUndocumented
Returns
strUndocumented