# 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:

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

## The template bridge

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.