sphinx.events.EventManager

class documentation

class EventManager:

View In Hierarchy

Event manager for Sphinx.
Method add Register a custom Sphinx event.
Method connect Connect a handler to specific event.
Method disconnect Disconnect a handler.
Method emit Emit a Sphinx event.
Method emit​_firstresult Emit a Sphinx event and returns first result.
Method __init__ Undocumented
Instance Variable app Undocumented
Instance Variable events Undocumented
Instance Variable listeners Undocumented
Instance Variable next​_listener​_id Undocumented
def add(self, name):
Register a custom Sphinx event.
Parameters
name:strUndocumented
def connect(self, name, callback, priority):
Connect a handler to specific event.
Parameters
name:strUndocumented
callback:CallableUndocumented
priority:intUndocumented
Returns
intUndocumented
def disconnect(self, listener_id):
Disconnect a handler.
Parameters
listener​_id:intUndocumented
def emit(self, name, *args, allowed_exceptions=()):
Emit a Sphinx event.
Parameters
name:strUndocumented
*args:AnyUndocumented
allowed​_exceptions:Tuple[Type[Exception], ...]Undocumented
Returns
ListUndocumented
def emit_firstresult(self, name, *args, allowed_exceptions=()):

Emit a Sphinx event and returns first result.

This returns the result of the first handler that doesn't return None.

Parameters
name:strUndocumented
*args:AnyUndocumented
allowed​_exceptions:Tuple[Type[Exception], ...]Undocumented
Returns
AnyUndocumented
def __init__(self, app):

Undocumented

Parameters
app:SphinxUndocumented
app =

Undocumented

events =

Undocumented

listeners: Dict[str, List[EventListener]] =

Undocumented

next_listener_id: int =

Undocumented