summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorAdam Turner <9087854+AA-Turner@users.noreply.github.com>2022-09-13 20:20:02 +0100
committerGitHub <noreply@github.com>2022-09-13 20:20:02 +0100
commitf57177de89ff1a154c830558d218c3e334b2b437 (patch)
treefd3086cf2e716b9973d8efe4904b3fabdc18ac3a /doc/extdev
parentb34765780950a04a8a387b1cafa33bf99b704bde (diff)
downloadsphinx-git-f57177de89ff1a154c830558d218c3e334b2b437.tar.gz
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
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/domainapi.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/extdev/domainapi.rst b/doc/extdev/domainapi.rst
index a666fc06d..d70b5db75 100644
--- a/doc/extdev/domainapi.rst
+++ b/doc/extdev/domainapi.rst
@@ -17,6 +17,7 @@ Domain API
.. autoclass:: ObjectDescription
:members:
+ :private-members: _toc_entry_name, _object_hierarchy_parts
Python Domain
-------------