mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-25 22:50:22 -05:00
Shengyu ZhangandAdam Turner
d347149f55
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
37 lines
585 B
ReStructuredText
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
|