sphinx.util.docutils.sphinx_domains

class documentation

class sphinx_domains(CustomReSTDispatcher): (source)

View In Hierarchy

Monkey-patch directive and role dispatch, so that domain-specific markup takes precedence.

Method __init__ Undocumented
Method directive Undocumented
Method lookup_domain_element Lookup a markup element (directive or role), given its name which can be a full name (with domain).
Method role Undocumented
Instance Variable env Undocumented

Inherited from CustomReSTDispatcher:

Method __enter__ Undocumented
Method __exit__ Undocumented
Method disable Undocumented
Method enable Undocumented
Instance Variable directive_func Undocumented
Instance Variable role_func Undocumented
Instance Variable roles_func Undocumented
def __init__(self, env): (source)
overrides sphinx.util.docutils.CustomReSTDispatcher.__init__

Undocumented

Parameters
env:BuildEnvironmentUndocumented
def directive(self, directive_name, language_module, document): (source)
overrides sphinx.util.docutils.CustomReSTDispatcher.directive

Undocumented

Parameters
directive_name:strUndocumented
language_module:ModuleTypeUndocumented
document:nodes.documentUndocumented
Returns
tuple[type[Directive]|None, list[system_message]]Undocumented
def lookup_domain_element(self, type, name): (source)

Lookup a markup element (directive or role), given its name which can be a full name (with domain).

Parameters
type:strUndocumented
name:strUndocumented
Returns
AnyUndocumented
def role(self, role_name, language_module, lineno, reporter): (source)
overrides sphinx.util.docutils.CustomReSTDispatcher.role

Undocumented

Parameters
role_name:strUndocumented
language_module:ModuleTypeUndocumented
lineno:intUndocumented
reporter:ReporterUndocumented
Returns
tuple[RoleFunction, list[system_message]]Undocumented
env = (source)

Undocumented