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

Document `sphinx.domains.IndexEntry` (#12820)

Browse Source 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Shengyu Zhang 2024-09-02 23:30:49 +08:00 committed by GitHub
parent 15aadd6e1a
commit d347149f55
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 35 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/extdev/domainapi.rst
View File

@ -13,6 +13,10 @@ Domain API
.. autoclass:: Index
:members:
.. autoclass:: IndexEntry
:members:
:member-order: bysource
.. module:: sphinx.directives
.. autoclass:: ObjectDescription

65
sphinx/domains/_index.py
View File

@ -14,12 +14,41 @@ if TYPE_CHECKING:
class IndexEntry(NamedTuple):
"""
An index entry.
.. note::
The *qualifier* and *description* are not rendered for some output formats,
such as LaTeX.
"""
#: The name of the index entry to be displayed.
name: str
#: The sub-entry related type. One of:
#:
#: ``0``
#: A normal entry.
#: ``1``
#: An entry with sub-entries.
#: ``2``
#: A sub-entry.
subtype: int
#: *docname* where the entry is located.
docname: str
#: Anchor for the entry within `docname`
anchor: str
#: Extra info for the entry.
extra: str
#: Qualifier for the description.
qualifier: str
#: Description for the entry.
descr: str
@ -75,39 +104,7 @@ class Index(ABC):
``content``:
A sequence of ``(letter, entries)`` tuples, where ``letter`` is the
"heading" for the given ``entries``, usually the starting letter, and
``entries`` is a sequence of single entries. Each entry is a sequence
``[name, subtype, docname, anchor, extra, qualifier, descr]``. The
items in this sequence have the following meaning:
``name``
The name of the index entry to be displayed.
``subtype``
The sub-entry related type. One of:
``0``
A normal entry.
``1``
An entry with sub-entries.
``2``
A sub-entry.
``docname``
*docname* where the entry is located.
``anchor``
Anchor for the entry within ``docname``
``extra``
Extra info for the entry.
``qualifier``
Qualifier for the description.
``descr``
Description for the entry.
Qualifier and description are not rendered for some output formats such
as LaTeX.
``entries`` is a sequence of single entries.
Each entry is an :py:class:`IndexEntry`.
"""
raise NotImplementedError