sphinx.util.docutils.SphinxRole

class documentation

class SphinxRole:

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

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 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 run Undocumented
Method set​_source​_info Undocumented
def get_location(self):
Get current location info for logging.
Returns
strUndocumented
content =

Undocumented

inliner =

Undocumented

lineno =

Undocumented

name =

Undocumented

options =

Undocumented

rawtext =

Undocumented

text =
overridden in sphinx.roles.MenuSelection

Undocumented

@property
config: Config =
Reference to the .Config object.
@property
env: BuildEnvironment =
Reference to the .BuildEnvironment object.
def __call__(self, name, rawtext, text, lineno, inliner, options={}, content=[]):
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_source_info(self, lineno=None):

Undocumented

Parameters
lineno:intUndocumented
Returns
Tuple[str, int]Undocumented
def run(self):
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):

Undocumented

Parameters
node:NodeUndocumented
lineno:intUndocumented