sphinx / doc / ext / appapi.rst

Extension API

Each Sphinx extension is a Python module with at least a :func:`setup` function. This function is called at initialization time with one argument, the application object representing the Sphinx process. This application object has the following public API:

Examples of using the Sphinx extension API can be seen in the :mod:`sphinx.ext` package.

Sphinx core events

These events are known to the core. The arguments shown are given to the registered event handlers.

The template bridge

Domain API