sphinx.util.docutils.ReferenceRole

class documentation

class ReferenceRole(SphinxRole): (source)

Known subclasses: sphinx.domains.index.IndexRole, sphinx.roles.PEP, sphinx.roles.RFC, sphinx.roles.XRefRole

A base class for reference roles. The reference roles can accept ``link title <target>`` style as a text for the role. The parsed result; link title and target will be stored to ``self.title`` and ``self.target``.

Method	`__call__`	Undocumented
Class Variable	`explicit_title_re`	Undocumented
Instance Variable	`disabled`	Undocumented
Instance Variable	`has_explicit_title`	Undocumented
Instance Variable	`target`	Undocumented
Instance Variable	`title`	Undocumented

Inherited from SphinxRole:

Method	`get_location`	Get current location info for logging.
Method	`get_source_info`	Undocumented
Method	`run`	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 __call__(self, name, rawtext, text, lineno, inliner, options={}, content=[]): (source) ¶

overrides sphinx.util.docutils.SphinxRole.__call__

Undocumented

Parameters
name:`str`	Undocumented
rawtext:`str`	Undocumented
text:`str`	Undocumented
lineno:`int`	Undocumented
inliner:`Inliner`	Undocumented
options:`dict`	Undocumented
content:`list[str]`	Undocumented
Returns
`tuple[list[Node], list[system_message]]`	Undocumented

explicit_title_re = (source) ¶

Undocumented

disabled = (source) ¶

Undocumented

has_explicit_title: bool = (source) ¶

overridden in sphinx.roles.XRefRole

Undocumented

target = (source) ¶

Undocumented

title = (source) ¶

Undocumented