sphinx.domains.index.IndexDomain

class documentation

class IndexDomain(Domain):

Mathematics domain.

Method	`clear_doc`	Remove traces of a document in the domain-specific inventories.
Method	`merge_domaindata`	Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).
Method	`process_doc`	Process a document after it is read by the environment.
Class Variable	`label`	Undocumented
Class Variable	`name`	Undocumented
Property	`entries`	Undocumented

Inherited from Domain:

Method	`add_object_type`	Add an object type.
Method	`check_consistency`	Do consistency checks (experimental).
Method	`directive`	Return a directive adapter class that always gives the registered directive its full name ('domain:name') as `self.name`.
Method	`get_enumerable_node_type`	Get type of enumerable nodes (experimental).
Method	`get_full_qualified_name`	Return full qualified name for given node.
Method	`get_objects`	Return an iterable of "object descriptions".
Method	`get_type_name`	Return full name for given ObjType.
Method	`process_field_xref`	Process a pending xref created in a doc field. For example, attach information about the current scope.
Method	`resolve_any_xref`	Resolve the pending_xref node with the given target.
Method	`resolve_xref`	Resolve the pending_xref node with the given typ and target.
Method	`role`	Return a role adapter function that always gives the registered role its full name ('domain:name') as the first argument.
Method	`setup`	Set up domain object.
Class Variable	`dangling_warnings`	Undocumented
Class Variable	`data_version`	Undocumented
Class Variable	`enumerable_nodes`	Undocumented
Class Variable	`initial_data`	Undocumented
Instance Variable	`data`	Undocumented
Instance Variable	`directives`	Undocumented
Instance Variable	`indices`	Undocumented
Instance Variable	`object_types`	Undocumented
Instance Variable	`roles`	Undocumented
Method	`__init__`	Undocumented
Instance Variable	`_directive_cache`	Undocumented
Instance Variable	`_role2type`	Undocumented
Instance Variable	`_role_cache`	Undocumented
Instance Variable	`_type2role`	Undocumented
Instance Variable	`env`	Undocumented
Instance Variable	`objtypes_for_role`	Undocumented
Instance Variable	`role_for_objtype`	Undocumented

def clear_doc(self, docname):

overrides sphinx.domains.Domain.clear_doc

Remove traces of a document in the domain-specific inventories.

Parameters
docname:`str`	Undocumented

def merge_domaindata(self, docnames, otherdata):

overrides sphinx.domains.Domain.merge_domaindata

Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).

Parameters
docnames:`Iterable[str]`	Undocumented
otherdata:`Dict`	Undocumented

def process_doc(self, env, docname, document):

overrides sphinx.domains.Domain.process_doc

Process a document after it is read by the environment.

Parameters
env:`BuildEnvironment`	Undocumented
docname:`str`	Undocumented
document:`Node`	Undocumented

label: str =

overrides sphinx.domains.Domain.label

Undocumented

name: str =

overrides sphinx.domains.Domain.name

Undocumented

@property
entries: Dict[str, List[Tuple[str, str, str, str, str]]] =

Undocumented