summaryrefslogtreecommitdiffstats
path: root/doc/extdev/domainapi.rst
blob: d70b5db751dd8d25850c836be8bcc03c09e2f152 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.. _domain-api:

Domain API
==========

.. module:: sphinx.domains

.. autoclass:: Domain
   :members:

.. autoclass:: ObjType

.. autoclass:: Index
   :members:

.. module:: sphinx.directives

.. autoclass:: ObjectDescription
   :members:
   :private-members: _toc_entry_name, _object_hierarchy_parts

Python Domain
-------------

.. module:: sphinx.domains.python

.. autoclass:: PythonDomain

   .. autoattribute:: objects
   .. autoattribute:: modules
   .. automethod:: note_object
   .. automethod:: note_module