diff options
| author | Georg Brandl <georg@python.org> | 2011-01-07 16:41:44 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-07 16:41:44 +0100 |
| commit | 3448ad3099e0c30e6901589b6bd8e181a449c6aa (patch) | |
| tree | 219f7b58613d9d97b1de55669423f8b999dd078f /doc/ext/appapi.rst | |
| parent | 3411097bf8a2ba377e763c9d31e46fc74f7914c3 (diff) | |
| download | sphinx-3448ad3099e0c30e6901589b6bd8e181a449c6aa.tar.gz | |
#306: Added :event:`env-get-outdated` event.
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index aa314584..5337f4cc 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -352,6 +352,15 @@ registered event handlers. Emitted when the builder object has been created. It is available as ``app.builder``. +.. event:: env-get-outdated (app, env, added, changed, removed) + + Emitted when the environment determines which source files have changed and + should be re-read. *added*, *changed* and *removed* are sets of docnames + that the environment has determined. You can return a list of docnames to + re-read in addition to these. + + .. versionadded:: 1.1 + .. event:: env-purge-doc (app, env, docname) Emitted when all traces of a source file should be cleaned from the |