summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/appapi.rst2
-rw-r--r--doc/extdev/builderapi.rst5
-rw-r--r--doc/extdev/envapi.rst4
-rw-r--r--doc/extdev/utils.rst6
4 files changed, 16 insertions, 1 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 4cb8501be..18eea34e7 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -145,7 +145,7 @@ Sphinx core events
------------------
These events are known to the core. The arguments shown are given to the
-registered event handlers. Use :meth:`.connect` in an extension's ``setup``
+registered event handlers. Use :meth:`.Sphinx.connect` in an extension's ``setup``
function (note that ``conf.py`` can also have a ``setup`` function) to connect
handlers to the events. Example:
diff --git a/doc/extdev/builderapi.rst b/doc/extdev/builderapi.rst
index 2c2cf12e3..0ab7a30f4 100644
--- a/doc/extdev/builderapi.rst
+++ b/doc/extdev/builderapi.rst
@@ -38,3 +38,8 @@ Builder API
.. automethod:: write_doc
.. automethod:: finish
+ **Attributes**
+
+ .. attribute:: events
+
+ An :class:`.EventManager` object.
diff --git a/doc/extdev/envapi.rst b/doc/extdev/envapi.rst
index 1dee6a576..d7ec23925 100644
--- a/doc/extdev/envapi.rst
+++ b/doc/extdev/envapi.rst
@@ -27,6 +27,10 @@ Build environment API
Directory for storing pickled doctrees.
+ .. attribute:: events
+
+ An :class:`.EventManager` object.
+
.. attribute:: found_docs
A set of all existing docnames.
diff --git a/doc/extdev/utils.rst b/doc/extdev/utils.rst
index 2a94a34bb..e842f3032 100644
--- a/doc/extdev/utils.rst
+++ b/doc/extdev/utils.rst
@@ -29,3 +29,9 @@ components (e.g. :class:`.Config`, :class:`.BuildEnvironment` and so on) easily.
.. autoclass:: sphinx.transforms.post_transforms.images.ImageConverter
:members:
+
+Utility components
+------------------
+
+.. autoclass:: sphinx.events.EventManager
+ :members: