IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
d8fa98e46ac74abc4d1941a05ef427b2bb711337
sphinx/doc/extdev/domainapi.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

33 lines
518 B
ReStructuredText
Raw Normal View History

Doc: move API docs in their own chapter and add more of it.
2014-01-20 17:21:44 +01:00
.. _domain-api:
Domain API
Fix #7875: doc: Add PythonDomain.note_object()
2020-12-26 21:12:15 +09:00
==========
Doc: move API docs in their own chapter and add more of it.
2014-01-20 17:21:44 +01:00
.. module:: sphinx.domains
.. autoclass:: Domain
:members:
.. autoclass:: ObjType
.. autoclass:: Index
:members:
Fix #7875: doc: Add PythonDomain.note_object()
2020-12-26 21:12:15 +09:00
Add doc for ObjectDescription (refs: #9662)
2021-09-23 12:56:09 +09:00
.. module:: sphinx.directives
.. autoclass:: ObjectDescription
:members:
Add contents entries for domain objects (#10807) - 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
2022-09-13 20:20:02 +01:00
:private-members: _toc_entry_name, _object_hierarchy_parts
Fix #7875: doc: Add PythonDomain.note_object()
2020-12-26 21:12:15 +09:00
Python Domain
-------------
.. module:: sphinx.domains.python
.. autoclass:: PythonDomain
.. autoattribute:: objects
.. autoattribute:: modules
.. automethod:: note_object
.. automethod:: note_module
Reference in New Issue Copy Permalink