o Ni @s|dZddlmZddlmZmZddlmZmZddl m Z er,ddl m Z ddl mZGdd d eZGd d d eZd S) zDomain indices.) annotations)ABCabstractmethod) TYPE_CHECKING NamedTuple) SphinxError)Iterable)Domainc@sJeZdZUdZded<ded<ded<ded<ded<ded <ded <d S) IndexEntryz An index entry. .. note:: The *qualifier* and *description* are not rendered for some output formats, such as LaTeX. strnameintsubtypedocnameanchorextra qualifierdescrN)__name__ __module__ __qualname____doc____annotations__rrI/home/ubuntu/.local/lib/python3.10/site-packages/sphinx/domains/_index.pyr s    r c@sJeZdZUdZded<ded<dZded<dd d Ze ddddZdS)Indexa An Index is the description for a domain-specific index. To add an index to a domain, subclass Index, overriding the three name attributes: * `name` is an identifier used for generating file names. It is also used for a hyperlink target for the index. Therefore, users can refer the index page using ``ref`` role and a string which is combined domain name and ``name`` attribute (ex. ``:ref:`py-modindex```). * `localname` is the section title for the index. * `shortname` is a short name for the index, for use in the relation bar in HTML output. Can be empty to disable entries in the relation bar. and providing a :meth:`generate()` method. Then, add the index class to your domain's `indices` list. Extensions can add indices to existing domains using :meth:`~sphinx.application.Sphinx.add_index_to_domain()`. .. versionchanged:: 3.0 Index pages can be referred by domain name and index name via :rst:role:`ref` role. r r localnameNz str | None shortnamedomainr returnNonecCs2|jr|jdurd|jjd}t|||_dS)NzIndex subclass z has no valid name or localname)r r __class__rrr)selfrmsgrrr__init__Rs zIndex.__init__docnamesIterable[str] | None/tuple[list[tuple[str, list[IndexEntry]]], bool]cCst)aGet entries for the index. If ``docnames`` is given, restrict to entries referring to these docnames. The return value is a tuple of ``(content, collapse)``: ``collapse`` A boolean that determines if sub-entries should start collapsed (for output formats that support collapsing sub-entries). ``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 an :py:class:`IndexEntry`. )NotImplementedError)r"r%rrrgenerateXszIndex.generate)rr rr )N)r%r&rr') rrrrrrr$rr)rrrrr7s   rN)r __future__rabcrrtypingrr sphinx.errorsrcollections.abcrsphinx.domainsr r rrrrrs    '