sphinx.events.EventManager

class documentation

class EventManager: (source)

View In Hierarchy

Event manager for Sphinx.

Method __init__ Undocumented
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.
Instance Variable app Undocumented
Instance Variable events Undocumented
Instance Variable listeners Undocumented
Instance Variable next_listener_id Undocumented
def __init__(self, app): (source)

Undocumented

Parameters
app:SphinxUndocumented
def add(self, name): (source)

Register a custom Sphinx event.

Parameters
name:strUndocumented
def connect(self, name, callback, priority): (source)

Connect a handler to specific event.

Parameters
name:strUndocumented
callback:CallableUndocumented
priority:intUndocumented
Returns
intUndocumented
def disconnect(self, listener_id): (source)

Disconnect a handler.

Parameters
listener_id:intUndocumented
def emit(self, name, *args, allowed_exceptions=()): (source)

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

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
app = (source)

Undocumented

events = (source)

Undocumented

listeners: dict[str, list[EventListener]] = (source)

Undocumented

next_listener_id: int = (source)

Undocumented