sphinx.roles

module documentation
(source)

Handlers for additional ReST roles.

Class Abbreviation Undocumented
Class AnyXRefRole Undocumented
Class EmphasizedLiteral Undocumented
Class GUILabel Undocumented
Class MenuSelection Undocumented
Class PEP Undocumented
Class RFC Undocumented
Class XRefRole A generic cross-referencing role. To create a callable that can be used as a role function, create an instance of this class.
Function code_role Undocumented
Function setup Undocumented
Variable generic_docroles Undocumented
Variable parens_re Undocumented
Variable specific_docroles Undocumented
Variable _abbr_re Undocumented
Variable _amp_re Undocumented
Variable _litvar_re Undocumented
def code_role(name, rawtext, text, lineno, inliner, options={}, content=[]): (source)

Undocumented

Parameters
name:strUndocumented
rawtext:strUndocumented
text:strUndocumented
lineno:intUndocumented
inliner:docutils.parsers.rst.states.InlinerUndocumented
options:dictUndocumented
content:list[str]Undocumented
Returns
tuple[list[Node], list[system_message]]Undocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
generic_docroles = (source)

Undocumented

parens_re = (source)

Undocumented

specific_docroles: dict[str, RoleFunction] = (source)

Undocumented

_abbr_re = (source)

Undocumented

_amp_re = (source)

Undocumented

_litvar_re = (source)

Undocumented