diff options
| author | Georg Brandl <georg@python.org> | 2010-02-27 23:13:51 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-02-27 23:13:51 +0100 |
| commit | 42fc484adb89d951066b49143ce62c0264bca3f2 (patch) | |
| tree | 304ce3d473bca3a1fef38dce0dad72b55a59c381 /doc/ext/appapi.rst | |
| parent | 0b6666904b8535b1c80d75eb27fe6ca6f0ab1e89 (diff) | |
| download | sphinx-42fc484adb89d951066b49143ce62c0264bca3f2.tar.gz | |
Add app.override_domain().
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 8df028e1..b536fd98 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -45,16 +45,24 @@ the following public API: .. method:: Sphinx.add_domain(domain) - Make the given *domain* (which must be a subclass of + Make the given *domain* (which must be a class; more precisely, a subclass of :class:`sphinx.domains.Domain`) known to Sphinx. .. XXX where is Domain documented? .. versionadded:: 1.0 +.. method:: Sphinx.override_domain(domain) + + Make the given *domain* known to Sphinx, assuming that there is already a + domain with its ``.name``. The new domain must be a subclass of the existing + one. + + .. versionadded:: 1.0 + .. method:: Sphinx.add_event(name) - Register an event called *name*. + Register an event called *name*. This is needed to be able to emit it. .. method:: Sphinx.add_node(node, **kwds) |
