class documentation

class IntersphinxRole(SphinxRole):

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
Class Variable ​_re​_inv​_ref Undocumented
Instance Variable orig​_name Undocumented

Inherited from SphinxRole:

Method get​_location Get current location info for logging.
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 .Config object.
Property env Reference to the .BuildEnvironment object.
Method __call__ Undocumented
Method get​_source​_info Undocumented
Method set​_source​_info Undocumented
def __init__(self, orig_name):

Undocumented

Parameters
orig​_name:strUndocumented
def get_inventory_and_name_suffix(self, name):

Undocumented

Parameters
name:strUndocumented
Returns
Tuple[Optional[str], str]Undocumented
def get_role_name(self, name):

Undocumented

Parameters
name:strUndocumented
Returns
Optional[Tuple[str, str]]Undocumented
def invoke_role(self, role):

Undocumented

Parameters
role:Tuple[str, str]Undocumented
Returns
Tuple[List[Node], List[system_message]]Undocumented
def is_existent_role(self, domain_name, role_name):

Undocumented

Parameters
domain​_name:strUndocumented
role​_name:strUndocumented
Returns
boolUndocumented
def run(self):

Undocumented

Returns
Tuple[List[Node], List[system_message]]Undocumented
_re_inv_ref =

Undocumented

orig_name =

Undocumented