sphinx/doc/extdev/domainapi.rst
Shengyu Zhang d347149f55
Document `sphinx.domains.IndexEntry` (#12820)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-09-02 10:30:49 -05:00

37 lines
585 B
ReStructuredText

.. _domain-api:
Domain API
==========
.. module:: sphinx.domains
.. autoclass:: Domain
:members:
.. autoclass:: ObjType
.. autoclass:: Index
:members:
.. autoclass:: IndexEntry
:members:
:member-order: bysource
.. 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