sphinx.util.docutils.CustomReSTDispatcher

class documentation

class CustomReSTDispatcher: (source)

Known subclasses: sphinx.ext.intersphinx.IntersphinxDispatcher, sphinx.util.docutils.sphinx_domains

View In Hierarchy

Custom reST's mark-up dispatcher. This replaces docutils's directives and roles dispatch mechanism for reST parser by original one temporarily.

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Undocumented
Method directive Undocumented
Method disable Undocumented
Method enable Undocumented
Method role Undocumented
Instance Variable directive_func Undocumented
Instance Variable role_func Undocumented
Instance Variable roles_func Undocumented
def __enter__(self): (source)

Undocumented

def __exit__(self, exc_type, exc_value, traceback): (source)

Undocumented

Parameters
exc_type:type[Exception]Undocumented
exc_value:ExceptionUndocumented
traceback:AnyUndocumented
def __init__(self): (source)
overridden in sphinx.util.docutils.sphinx_domains

Undocumented

def directive(self, directive_name, language_module, document): (source)
overridden in sphinx.util.docutils.sphinx_domains

Undocumented

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

Undocumented

def enable(self): (source)

Undocumented

def role(self, role_name, language_module, lineno, reporter): (source)
overridden in sphinx.ext.intersphinx.IntersphinxDispatcher, sphinx.util.docutils.sphinx_domains

Undocumented

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

Undocumented

role_func = (source)

Undocumented

roles_func: Callable = (source)

Undocumented