sphinx.domains.std.StandardDomain

class documentation

class StandardDomain(Domain):

Domain for all objects that don't fit into another domain or are added via the application interface.

Method	`__init__`	Undocumented
Method	`_note_term`	Note a term for cross reference.
Method	`_resolve_doc_xref`	Undocumented
Method	`_resolve_keyword_xref`	Undocumented
Method	`_resolve_numref_xref`	Undocumented
Method	`_resolve_obj_xref`	Undocumented
Method	`_resolve_option_xref`	Undocumented
Method	`_resolve_ref_xref`	Undocumented
Method	`_resolve_term_xref`	Undocumented
Method	`add_object`	Undocumented
Method	`add_program_option`	Undocumented
Method	`build_reference_node`	Undocumented
Method	`clear_doc`	Remove traces of a document in the domain-specific inventories.
Method	`get_enumerable_node_type`	Get type of enumerable nodes.
Method	`get_fignumber`	Undocumented
Method	`get_full_qualified_name`	Return full qualified name for given node.
Method	`get_numfig_title`	Get the title of enumerable nodes to refer them using its title
Method	`get_objects`	Return an iterable of "object descriptions".
Method	`get_type_name`	Return full name for given ObjType.
Method	`is_enumerable_node`	Undocumented
Method	`merge_domaindata`	Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).
Method	`note_hyperlink_target`	Add a hyperlink target for cross reference.
Method	`note_object`	Note a generic object for cross reference.
Method	`process_doc`	Process a document after it is read by the environment.
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.
Class Variable	`dangling_warnings`	Undocumented
Class Variable	`directives`	Undocumented
Class Variable	`initial_data`	Undocumented
Class Variable	`label`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`object_types`	Undocumented
Class Variable	`roles`	Undocumented
Instance Variable	`enumerable_nodes`	Undocumented
Property	`_terms`	Note Will be removed soon. internal use only.
Property	`anonlabels`	Undocumented
Property	`labels`	Undocumented
Property	`objects`	Undocumented
Property	`progoptions`	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	`process_field_xref`	Process a pending xref created in a doc field. For example, attach information about the current scope.
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	`data_version`	Undocumented
Instance Variable	`data`	Undocumented
Instance Variable	`indices`	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 __init__(self, env):

overrides sphinx.domains.Domain.__init__

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented

def _note_term(self, term, labelid, location=None):

Note a term for cross reference.

Note

Will be removed soon. internal use only.

Parameters
term:`str`	Undocumented
labelid:`str`	Undocumented
location:`Any`	Undocumented

def _resolve_doc_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_keyword_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_numref_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_obj_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_option_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_ref_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_term_xref(self, env, fromdocname, builder, typ, target, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Element`	Undocumented

def add_object(self, objtype, name, docname, labelid):

Undocumented

Parameters
objtype:`str`	Undocumented
name:`str`	Undocumented
docname:`str`	Undocumented
labelid:`str`	Undocumented

def add_program_option(self, program, name, docname, labelid):

Undocumented

Parameters
program:`str`	Undocumented
name:`str`	Undocumented
docname:`str`	Undocumented
labelid:`str`	Undocumented

def build_reference_node(self, fromdocname, builder, docname, labelid, sectname, rolename, **options):

Undocumented

Parameters
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
docname:`str`	Undocumented
labelid:`str`	Undocumented
sectname:`str`	Undocumented
rolename:`str`	Undocumented
**options:`Any`	Undocumented
Returns
`Element`	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 get_enumerable_node_type(self, node):

overrides sphinx.domains.Domain.get_enumerable_node_type

Get type of enumerable nodes.

Parameters
node:`Node`	Undocumented
Returns
`Optional[str]`	Undocumented

def get_fignumber(self, env, builder, figtype, docname, target_node):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
builder:`Builder`	Undocumented
figtype:`str`	Undocumented
docname:`str`	Undocumented
target_node:`Element`	Undocumented
Returns
`Tuple[int, ...]`	Undocumented

def get_full_qualified_name(self, node):

overrides sphinx.domains.Domain.get_full_qualified_name

Return full qualified name for given node.

Parameters
node:`Element`	Undocumented
Returns
`Optional[str]`	Undocumented

def get_numfig_title(self, node):

Get the title of enumerable nodes to refer them using its title

Parameters
node:`Node`	Undocumented
Returns
`Optional[str]`	Undocumented

def get_objects(self):

overrides sphinx.domains.Domain.get_objects

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.

Returns
`Iterator[Tuple[str, str, str, str, str, int]]`	Undocumented

def get_type_name(self, type, primary=False):

overrides sphinx.domains.Domain.get_type_name

Return full name for given ObjType.

Parameters
type:`ObjType`	Undocumented
primary:`bool`	Undocumented
Returns
`str`	Undocumented

def is_enumerable_node(self, node):

Undocumented

Parameters
node:`Node`	Undocumented
Returns
`bool`	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:`List[str]`	Undocumented
otherdata:`Dict`	Undocumented

def note_hyperlink_target(self, name, docname, node_id, title=''):

Add a hyperlink target for cross reference.

Warning

This is only for internal use. Please don't use this from your extension. document.note_explicit_target() or note_implicit_target() are recommended to add a hyperlink target to the document.

This only adds a hyperlink target to the StandardDomain. And this does not add a node_id to node. Therefore, it is very fragile to calling this without understanding hyperlink target framework in both docutils and Sphinx.

New in version 3.0.

Parameters
name:`str`	Undocumented
docname:`str`	Undocumented
node_id:`str`	Undocumented
title:`str`	Undocumented

def note_object(self, objtype, name, labelid, location=None):

Note a generic object for cross reference.

New in version 3.0.

Parameters
objtype:`str`	Undocumented
name:`str`	Undocumented
labelid:`str`	Undocumented
location:`Any`	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:`nodes.document`	Undocumented

def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode):

overrides sphinx.domains.Domain.resolve_any_xref

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 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 resolve_xref would return.

New in version 1.3.

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`List[Tuple[str, Element]]`	Undocumented

def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):

overrides sphinx.domains.Domain.resolve_xref

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 sphinx.environment.NoUri to suppress the :event:`missing-reference` event being emitted.

Parameters
env:`BuildEnvironment`	Undocumented
fromdocname:`str`	Undocumented
builder:`Builder`	Undocumented
typ:`str`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Optional[Element]`	Undocumented

dangling_warnings: dict[str, str] =

overrides sphinx.domains.Domain.dangling_warnings

Undocumented

directives: Dict[str, Type[Directive]] =

overrides sphinx.domains.Domain.directives

Undocumented

initial_data =

overrides sphinx.domains.Domain.initial_data

Undocumented

label: str =

overrides sphinx.domains.Domain.label

Undocumented

name: str =

overrides sphinx.domains.Domain.name

Undocumented

object_types: Dict[str, ObjType] =

overrides sphinx.domains.Domain.object_types

Undocumented

roles: Dict[str, Union[RoleFunction, XRefRole]] =

overrides sphinx.domains.Domain.roles

Undocumented

enumerable_nodes =

overrides sphinx.domains.Domain.enumerable_nodes

Undocumented

@property
_terms: Dict[str, Tuple[str, str]] =

Note

Will be removed soon. internal use only.

@property
anonlabels: Dict[str, Tuple[str, str]] =

Undocumented

@property
labels: Dict[str, Tuple[str, str, str]] =

Undocumented

@property
objects: Dict[Tuple[str, str], Tuple[str, str]] =

Undocumented

@property
progoptions: Dict[Tuple[str, str], Tuple[str, str]] =

Undocumented