sphinx.domains.std.OptionXRefRole

class documentation

class OptionXRefRole(XRefRole):

View In Hierarchy

Undocumented

Method process​_link No summary

Inherited from XRefRole:

Method __init__ Undocumented
Method create​_non​_xref​_node Undocumented
Method create​_xref​_node Undocumented
Method result​_nodes No summary
Method run Undocumented
Method update​_title​_and​_target Undocumented
Instance Variable classes Undocumented
Instance Variable fix​_parens Undocumented
Instance Variable has​_explicit​_title Undocumented
Instance Variable innernodeclass Undocumented
Instance Variable lowercase Undocumented
Instance Variable nodeclass Undocumented
Instance Variable refdomain Undocumented
Instance Variable reftype Undocumented
Instance Variable warn​_dangling Undocumented

Inherited from ReferenceRole (via XRefRole):

Instance Variable disabled Undocumented
Instance Variable target Undocumented
Instance Variable title Undocumented
Method __call__ Undocumented
Class Variable explicit​_title​_re Undocumented

Inherited from SphinxRole (via XRefRole, ReferenceRole):

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 get​_source​_info Undocumented
Method set​_source​_info Undocumented
def process_link(self, env, refnode, has_explicit_title, title, target):
overrides sphinx.roles.XRefRole.process_link
Called after parsing title and target text, and creating the reference node (given in refnode). This method can alter the reference node and must return a new (or the same) (title, target) tuple.
Parameters
env:BuildEnvironmentUndocumented
refnode:ElementUndocumented
has​_explicit​_title:boolUndocumented
title:strUndocumented
target:strUndocumented
Returns
Tuple[str, str]Undocumented