mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
f57177de89
- Add entries in the table of contents for domain objects (e.g. `py:function`, `rst:role`, etc). Supported domains are Javascript, Python, and reStructuredText. - Support content in `py:module` and `js:module` directives. - Add the `noindexentry` and `noindex` flags to more domains. - Add `toc_object_entries_show_parents` configuration setting - Update documentation and tests
33 lines
518 B
ReStructuredText
33 lines
518 B
ReStructuredText
.. _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
|