File: domainapi.rst

package info (click to toggle)
sphinx 7.4.7-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 25,608 kB
  • sloc: python: 85,281; javascript: 6,139; perl: 451; makefile: 178; sh: 37; xml: 19; ansic: 2
file content (32 lines) | stat: -rw-r--r-- 518 bytes parent folder | download | duplicates (13)
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