sphinx.ext.intersphinx.IntersphinxRole

class documentation

class IntersphinxRole(SphinxRole): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method get_inventory_and_name_suffix Undocumented
Method get_role_name Undocumented
Method invoke_role Undocumented
Method is_existent_role Undocumented
Method run Undocumented
Instance Variable orig_name Undocumented
Class Variable _re_inv_ref Undocumented

Inherited from SphinxRole:

Method __call__ Undocumented
Method get_location Get current location info for logging.
Method get_source_info Undocumented
Method set_source_info Undocumented
Instance Variable content Undocumented
Instance Variable inliner Undocumented
Instance Variable lineno Undocumented
Instance Variable name Undocumented
Instance Variable options Undocumented
Instance Variable rawtext Undocumented
Instance Variable text Undocumented
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def __init__(self, orig_name): (source)

Undocumented

Parameters
orig_name:strUndocumented
def get_inventory_and_name_suffix(self, name): (source)

Undocumented

Parameters
name:strUndocumented
Returns
tuple[str|None, str]Undocumented
def get_role_name(self, name): (source)

Undocumented

Parameters
name:strUndocumented
Returns
tuple[str, str]|NoneUndocumented
def invoke_role(self, role): (source)

Undocumented

Parameters
role:tuple[str, str]Undocumented
Returns
tuple[list[Node], list[system_message]]Undocumented
def is_existent_role(self, domain_name, role_name): (source)

Undocumented

Parameters
domain_name:strUndocumented
role_name:strUndocumented
Returns
boolUndocumented
def run(self): (source)
overrides sphinx.util.docutils.SphinxRole.run

Undocumented

Returns
tuple[list[Node], list[system_message]]Undocumented
orig_name = (source)

Undocumented

_re_inv_ref = (source)

Undocumented