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 app.override_domain().

Browse Source
This commit is contained in:
Georg Brandl
2010-02-27 23:13:51 +01:00
parent 27683bcdd7
commit 76eb148770
2 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/ext/appapi.rst
View File

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