sphinx.domains.std.StandardDomain

class documentation

class StandardDomain(Domain): (source)

View In Hierarchy

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

Method __init__ 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*.
Constant initial_data Undocumented
Class Variable dangling_warnings Undocumented
Class Variable directives Undocumented
Class Variable label Undocumented
Class Variable name Undocumented
Class Variable object_types Undocumented
Class Variable roles Undocumented
Instance Variable enumerable_nodes Undocumented
Property anonlabels Undocumented
Property labels Undocumented
Property objects Undocumented
Property progoptions 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
Class Variable _virtual_doc_names Undocumented
Property _terms .. note:: Will be removed soon. internal use only.

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 env Undocumented
Instance Variable indices Undocumented
Instance Variable objtypes_for_role Undocumented
Instance Variable role_for_objtype Undocumented
Instance Variable _directive_cache Undocumented
Instance Variable _role2type Undocumented
Instance Variable _role_cache Undocumented
Instance Variable _type2role Undocumented
def __init__(self, env): (source)
overrides sphinx.domains.Domain.__init__

Undocumented

Parameters
env:BuildEnvironmentUndocumented
def add_program_option(self, program, name, docname, labelid): (source)

Undocumented

Parameters
program:strUndocumented
name:strUndocumented
docname:strUndocumented
labelid:strUndocumented
def build_reference_node(self, fromdocname, builder, docname, labelid, sectname, rolename, **options): (source)

Undocumented

Parameters
fromdocname:strUndocumented
builder:BuilderUndocumented
docname:strUndocumented
labelid:strUndocumented
sectname:strUndocumented
rolename:strUndocumented
**options:AnyUndocumented
Returns
ElementUndocumented
def clear_doc(self, docname): (source)
overrides sphinx.domains.Domain.clear_doc

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

Parameters
docname:strUndocumented
def get_enumerable_node_type(self, node): (source)
overrides sphinx.domains.Domain.get_enumerable_node_type

Get type of enumerable nodes.

Parameters
node:NodeUndocumented
Returns
str|NoneUndocumented
def get_fignumber(self, env, builder, figtype, docname, target_node): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
builder:BuilderUndocumented
figtype:strUndocumented
docname:strUndocumented
target_node:ElementUndocumented
Returns
tuple[int, ...]|NoneUndocumented
def get_full_qualified_name(self, node): (source)
overrides sphinx.domains.Domain.get_full_qualified_name

Return full qualified name for given node.

Parameters
node:ElementUndocumented
Returns
str|NoneUndocumented
def get_numfig_title(self, node): (source)

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

Parameters
node:NodeUndocumented
Returns
str|NoneUndocumented
def get_objects(self): (source)
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): (source)
overrides sphinx.domains.Domain.get_type_name

Return full name for given ObjType.

Parameters
type:ObjTypeUndocumented
primary:boolUndocumented
Returns
strUndocumented
def is_enumerable_node(self, node): (source)

Undocumented

Parameters
node:NodeUndocumented
Returns
boolUndocumented
def merge_domaindata(self, docnames, otherdata): (source)
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[str, Any]Undocumented
def note_hyperlink_target(self, name, docname, node_id, title=''): (source)

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. .. versionadded:: 3.0

Parameters
name:strUndocumented
docname:strUndocumented
node_id:strUndocumented
title:strUndocumented
def note_object(self, objtype, name, labelid, location=None): (source)

Note a generic object for cross reference. .. versionadded:: 3.0

Parameters
objtype:strUndocumented
name:strUndocumented
labelid:strUndocumented
location:AnyUndocumented
def process_doc(self, env, docname, document): (source)
overrides sphinx.domains.Domain.process_doc

Process a document after it is read by the environment.

Parameters
env:BuildEnvironmentUndocumented
docname:strUndocumented
document:nodes.documentUndocumented
def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode): (source)
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 :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

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
list[tuple[str, Element]]Undocumented
def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)
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 :exc:`sphinx.environment.NoUri` to suppress the :event:`missing-reference` event being emitted.

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
initial_data = (source)
overrides sphinx.domains.Domain.initial_data

Undocumented

Value
{'progoptions': {},
 'objects': {},
 'labels': {'genindex': ('genindex', '', _('Index')),
            'modindex': ('py-modindex', '', _('Module Index')),
            'search': ('search', '', _('Search Page'))},
 'anonlabels': {'genindex': ('genindex', ''),
                'modindex': ('py-modindex', ''),
...
dangling_warnings: dict[str, str] = (source)
overrides sphinx.domains.Domain.dangling_warnings

Undocumented

directives: dict[str, type[Directive]] = (source)
overrides sphinx.domains.Domain.directives

Undocumented

label: str = (source)
overrides sphinx.domains.Domain.label

Undocumented

name: str = (source)
overrides sphinx.domains.Domain.name

Undocumented

object_types: dict[str, ObjType] = (source)
overrides sphinx.domains.Domain.object_types

Undocumented

roles: dict[str, RoleFunction|XRefRole] = (source)
overrides sphinx.domains.Domain.roles

Undocumented

enumerable_nodes = (source)
overrides sphinx.domains.Domain.enumerable_nodes

Undocumented

@property
anonlabels: dict[str, tuple[str, str]] = (source)

Undocumented

@property
labels: dict[str, tuple[str, str, str]] = (source)

Undocumented

@property
objects: dict[tuple[str, str], tuple[str, str]] = (source)

Undocumented

@property
progoptions: dict[tuple[str, str], tuple[str, str]] = (source)

Undocumented

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

Note a term for cross reference. .. note:: Will be removed soon. internal use only.

Parameters
term:strUndocumented
labelid:strUndocumented
location:AnyUndocumented
def _resolve_doc_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_keyword_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_numref_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_obj_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_option_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_ref_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_term_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
_virtual_doc_names: dict[str, tuple[str, str]] = (source)

Undocumented

@property
_terms: dict[str, tuple[str, str]] = (source)

.. note:: Will be removed soon. internal use only.