sphinx.domains.Domain

Undocumented

Add an object type.

Do consistency checks (**experimental**).

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

Return a directive adapter class that always gives the registered directive its full name ('domain:name') as ``self.name``.

Get type of enumerable nodes (experimental).

Return full qualified name for given node.

Return an iterable of "object descriptions". Object descriptions are tuples with six items: ``name`` Fully qualified name. ``dispname`` Name to display when searching/linking. ``type`` Object type, a key in ``self.object_types``. ``docname`` The document where it is to be found. ``anchor`` The anchor name for the object. ``priority`` How "important" the object is (determines placement in search results). One of: ``1`` Default priority (placed before full-text matches). ``0`` Object is important (placed before default-priority objects). ``2`` Object is unimportant (placed after full-text matches). ``-1`` Object should not show up in search at all.

Return full name for given ObjType.

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

Process a document after it is read by the environment.

Process a pending xref created in a doc field. For example, attach information about the current scope.

Resolve the pending_xref *node* with the given *target*. The reference comes from an "any" or similar role, which means that we don't know the type. Otherwise, the arguments are the same as for :meth:`resolve_xref`. The method must return a list (potentially empty) of tuples ``('domain:role', newnode)``, where ``'domain:role'`` is the name of a role that could have created the same reference, e.g. ``'py:func'``. ``newnode`` is what :meth:`resolve_xref` would return. .. versionadded:: 1.3

Resolve the pending_xref *node* with the given *typ* and *target*. This method should return a new node, to replace the xref node, containing the *contnode* which is the markup content of the cross-reference. If no resolution can be found, None can be returned; the xref node will then given to the :event:`missing-reference` event, and if that yields no resolution, replaced by *contnode*. The method can also raise :exc:`sphinx.environment.NoUri` to suppress the :event:`missing-reference` event being emitted.

Return a role adapter function that always gives the registered role its full name ('domain:name') as the first argument.

Set up domain object.