Ri dZddlmZddlmZmZddlmZmZddl m Z erddl m Z ddlm Z ddlmZGd d eZGd d eZy )zDomain indices.) annotations)ABCabstractmethod) TYPE_CHECKING NamedTuple) SphinxError)Iterable)ClassVar)DomaincXeZdZUdZded<ded<ded<ded<ded<ded <ded <y ) IndexEntryzAn index entry. .. note:: The *qualifier* and *description* are not rendered for some output formats, such as LaTeX. strnameintsubtypedocnameanchorextra qualifierdescrN)__name__ __module__ __qualname____doc____annotations__M/home/agent/.friday_env/lib/python3.12/site-packages/sphinx/domains/_index.pyr r s8 ILL K JN Jrr cXeZdZUdZded<ded<dZded<d dZe d d d Zy) IndexaAn 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. z ClassVar[str]r localnameNzClassVar[str | None] shortnamec|jr |j%d|jjd}t |||_y)NzIndex subclass z has no valid name or localname)rr! __class__rrdomain)selfr%msgs r__init__zIndex.__init__Qs>yyDNN2#DNN$;$;#<<[\Cc" " rct)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&docnamess rgeneratezIndex.generateWs *"!r)r%r returnNone)N)r+zIterable[str] | Noner-z/tuple[list[tuple[str, list[IndexEntry]]], bool]) rrrrrr"r(rr,rrrr r 7sL* &*I#* /3"," 8""rr N)r __future__rabcrrtypingrr sphinx.errorsrcollections.abcr r sphinx.domainsr r r rrrr5s9"#,%(%##L5"C5"r