sphinx.domains.c.CDomain

class documentation

class CDomain(Domain):

View In Hierarchy

C language domain.
Method ​_resolve​_xref​_inner Undocumented
Method clear​_doc Remove traces of a document in the domain-specific inventories.
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​_full​_qualified​_name Return full qualified name for given node.
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:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
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:strUndocumented
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:DictUndocumented
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:BuildEnvironmentUndocumented
docname:strUndocumented
document:nodes.documentUndocumented
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_xrefUndocumented
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: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):
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:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Optional[Element]Undocumented
directives =
overrides sphinx.domains.Domain.directives

Undocumented

initial_data: Dict[str, Union[Symbol, Dict[str, Tuple[str, str, str]]]] =
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