diff options
| author | Georg Brandl <georg@python.org> | 2010-01-13 23:42:58 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-01-13 23:42:58 +0100 |
| commit | 05706159492a57568e615486e3c6032de521ea01 (patch) | |
| tree | 2a0e296b97a420f37ec4ef3f6d51e44a6746b62c /doc/ext/appapi.rst | |
| parent | 74b451ccfed4818eac625ef08a2abb5fd0845c29 (diff) | |
| download | sphinx-05706159492a57568e615486e3c6032de521ea01.tar.gz | |
Add html-collect-pages event.
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 7ed3d3d4..f3a4a061 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -360,7 +360,15 @@ registered event handlers. .. versionadded:: 0.5 -.. event:: page-context (app, pagename, templatename, context, doctree) +.. event:: html-collect-pages (app) + + Emitted when the HTML builder is starting to write non-document pages. You + can add pages to write by returning an iterable from this event consisting of + ``(pagename, context, templatename)``. + + .. versionadded:: 1.0 + +.. event:: html-page-context (app, pagename, templatename, context, doctree) Emitted when the HTML builder has created a context dictionary to render a template with -- this can be used to add custom elements to the context. |