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:
|Event name||Emitted when||Arguments|
|'builder-inited'||the builder object has been created||-none-|
|'doctree-read'||a doctree has been parsed and read by the environment, and is about to be pickled||doctree|
|'doctree-resolved'||a doctree has been "resolved" by the environment, that is, all references and TOCs have been inserted||doctree, docname|