sphinx.ext.intersphinx.IntersphinxDispatcher

class documentation

class IntersphinxDispatcher(CustomReSTDispatcher):

View In Hierarchy

Custom dispatcher for external role.

This enables :external:*:/:external+*: roles on parsing reST document.

Method role Undocumented

Inherited from CustomReSTDispatcher:

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Undocumented
Method directive Undocumented
Method disable Undocumented
Method enable Undocumented
Instance Variable directive​_func Undocumented
Instance Variable role​_func Undocumented
Instance Variable roles​_func Undocumented
def role(self, role_name, language_module, lineno, reporter):
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