sphinx.domains.cpp.CPPDomain

class documentation

class CPPDomain(Domain):

C++ language domain.

There are two 'object type' attributes being used:

- Each object created from directives gets an assigned .objtype from ObjectDescription.run.

This is simply the directive name.

Each declaration (see the distinction in the directives dict below) has a nested .ast of type ASTDeclaration. That object has .objectType which corresponds to the keys in the object_types dict below. They are the core different types of declarations in C++ that one can document.

Method	`_resolve_xref_inner`	Undocumented
Method	`clear_doc`	Remove traces of a document in the domain-specific inventories.
Method	`get_full_qualified_name`	Return full qualified name for given node.
Method	`get_objects`	Return an iterable of "object descriptions".
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.
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.
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

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_type_name`	Return full name for given ObjType.
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
Instance Variable	`data`	Undocumented
Instance Variable	`indices`	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 _resolve_xref_inner(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
`Tuple[Optional[Element], Optional[str]]`	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_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
`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 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 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 process_field_xref(self, pnode):

overrides sphinx.domains.Domain.process_field_xref

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

Parameters
pnode:`pending_xref`	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

directives =

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 =

overrides sphinx.domains.Domain.object_types

Undocumented

roles =

overrides sphinx.domains.Domain.roles

Undocumented