Expand description
The domains’ get_objects() (domains/__init__.py:285): every object a
domain exposes to the object inventory (objects.inv) and the search
index (searchindex.js), as the (name, dispname, type, docname, anchor, priority) rows Sphinx yields — plus the two per-type lookups both
consumers share, the search priority (ObjType.attrs['searchprio']) and
the localized type name (Domain.get_type_name).
One producer for both artifacts is the point: the inventory and the search index can only ever disagree about an object if Sphinx’s do.
Functions§
- domain_
objects - Both domains this build populates, in
env.domains.sorted()order, each sorted the waysorted(domain.get_objects())sorts its tuples. - object_
type_ name Domain.get_type_name(otype)(domains/__init__.py:318-322), asIndexBuilder.get_objectscalls it: the std domain overrides it to the bareObjType.lname(domains/std/__init__.py:1359); every other domain prefixes its label, so a Python class is aPython class. A type the domain has noObjTypefor is named by its type string, which is whatget_objectsfalls back to.- py_
domain_ objects PythonDomain.get_objects()(domains/python/__init__.py:1056-1065): modules come from the module registry at priority 0 and are skipped in the object registry; aliased objects are not full-text searchable.- std_
domain_ objects StandardDomain.get_objects()(domains/std/__init__.py:1283-1308).- std_
search_ priority ObjType(..., searchprio=...)for the std domain’s types (domains/std/__init__.py:725-734).ObjTypedefaultssearchprioto 1 (domains/__init__.py:53), so every type the table does not mark unsearchable —confval,envvar,cmdoption, and whateveradd_object_typeregisters — is 1.