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 general docstring processing support with a new event in autodoc.

Browse Source
This commit is contained in:
Georg Brandl
2008-06-22 21:02:50 +00:00
parent abddd96093
commit c1bedfc105
7 changed files with 117 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/ext/appapi.rst
View File

@@ -162,24 +162,24 @@ package.
Sphinx core events
------------------
These events are known to the core. The arguments showed are given to the
These events are known to the core. The arguments shown are given to the
registered event handlers.
.. event:: builder-inited ()
.. event:: builder-inited (app)
Emitted the builder object has been created.
.. event:: doctree-read (doctree)
.. event:: doctree-read (app, doctree)
Emitted when a doctree has been parsed and read by the environment, and is
about to be pickled.
.. event:: doctree-resolved (doctree, docname)
.. event:: doctree-resolved (app, doctree, docname)
Emitted when a doctree has been "resolved" by the environment, that is, all
references and TOCs have been inserted.
.. event:: page-context (pagename, templatename, context, doctree)
.. event:: 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.