sphinx.ext.intersphinx.IntersphinxDispatcher

class documentation

class IntersphinxDispatcher(CustomReSTDispatcher): (source)

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