sphinx.util.docutils.CustomReSTDispatcher

class documentation

class CustomReSTDispatcher:

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):

Undocumented

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

Undocumented

Parameters
exc​_type:Type[Exception]Undocumented
exc​_value:ExceptionUndocumented
traceback:AnyUndocumented
def __init__(self):
overridden in sphinx.util.docutils.sphinx_domains

Undocumented

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

Undocumented

Parameters
directive​_name:strUndocumented
language​_module:ModuleTypeUndocumented
document:nodes.documentUndocumented
Returns
Tuple[Optional[Type[Directive]], List[system_message]]Undocumented
def disable(self):

Undocumented

def enable(self):

Undocumented

def role(self, role_name, language_module, lineno, reporter):
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 =

Undocumented

role_func =

Undocumented

roles_func: Callable =

Undocumented