IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add html-collect-pages event.

Browse Source
This commit is contained in:
Georg Brandl
2010-01-13 23:42:58 +01:00
parent 65b426b22b
commit cbbae81e8f
4 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/ext/appapi.rst
View File

@@ -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.