sphinx.util.docutils.SphinxRole

class documentation

class SphinxRole: (source)

Known subclasses: sphinx.ext.autosummary.AutoLink, sphinx.ext.intersphinx.IntersphinxRole, sphinx.roles.Abbreviation, sphinx.roles.EmphasizedLiteral, sphinx.roles.GUILabel, sphinx.util.docutils.ReferenceRole

View In Hierarchy

A base class for Sphinx roles. This class provides helper methods for Sphinx roles. .. note:: The subclasses of this class might not work with docutils. This class is strongly coupled with Sphinx.

Method __call__ Undocumented
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)
overridden in sphinx.util.docutils.ReferenceRole

Undocumented

Parameters
name:strUndocumented
rawtext:strUndocumented
text:strUndocumented
lineno:intUndocumented
inliner:InlinerUndocumented
options:dictUndocumented
content:list[str]Undocumented
Returns
tuple[list[Node], list[system_message]]Undocumented
def get_location(self): (source)

Get current location info for logging.

Returns
strUndocumented
def get_source_info(self, lineno=None): (source)

Undocumented

Parameters
lineno:intUndocumented
Returns
tuple[str, int]Undocumented
def run(self): (source)
overridden in sphinx.domains.index.IndexRole, sphinx.ext.autosummary.AutoLink, sphinx.ext.intersphinx.IntersphinxRole, sphinx.roles.Abbreviation, sphinx.roles.EmphasizedLiteral, sphinx.roles.GUILabel, sphinx.roles.PEP, sphinx.roles.RFC, sphinx.roles.XRefRole

Undocumented

Returns
tuple[list[Node], list[system_message]]Undocumented
def set_source_info(self, node, lineno=None): (source)

Undocumented

Parameters
node:NodeUndocumented
lineno:intUndocumented
content = (source)

Undocumented

inliner = (source)

Undocumented

lineno = (source)

Undocumented

name = (source)

Undocumented

options = (source)

Undocumented

rawtext = (source)

Undocumented

text = (source)
overridden in sphinx.roles.MenuSelection

Undocumented

@property
config: Config = (source)

Reference to the :class:`.Config` object.

@property
env: BuildEnvironment = (source)

Reference to the :class:`.BuildEnvironment` object.