diff options
| author | georg.brandl <devnull@localhost> | 2008-10-16 19:04:45 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-10-16 19:04:45 +0000 |
| commit | 9e13d311b82d87992fdb9b9835738da46644353f (patch) | |
| tree | b70b2310996f150a63d33d55e5188e51e20285cb /doc/ext/appapi.rst | |
| parent | 1ba2faf6c1cd5ac6e81ce9b5af4d940b3d80e077 (diff) | |
| download | sphinx-9e13d311b82d87992fdb9b9835738da46644353f.tar.gz | |
Add "source-read" event.
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 551a9477..bb8ff7dd 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -208,6 +208,14 @@ registered event handlers. Emitted when the builder object has been created. It is available as ``app.builder``. +.. event:: source-read (app, docname, source) + + Emitted when a source file has been read. The *source* argument is a list + whose single element is the contents of the source file. You can process the + contents and replace this item to implement source-level transformations. + + .. versionadded:: 0.5 + .. event:: doctree-read (app, doctree) Emitted when a doctree has been parsed and read by the environment, and is |