orangeqs.juice._sphinx._domain

Module Contents

Classes

ConfigDomain

Custom Sphinx domain for configuration directives.

API

class orangeqs.juice._sphinx._domain.ConfigDomain(env: sphinx.environment.BuildEnvironment)

Bases: sphinx.domains.Domain

Custom Sphinx domain for configuration directives.

name

‘config’

label

‘Configuration’

directives

None

roles

None

initial_data: dict[str, list[Any]]

None

data_version

0

add_schema(signature: str) → None

Add a schema to the domain data.

Parameters

• signature (str): The signature of the node. Corresponds to the filename.

add_field(signature: str) → None

Add a field to the domain data.

Parameters

• signature (str): The signature of the node. Corresponds to the field path, prefixed by the schema filename.

resolve_xref(env: sphinx.environment.BuildEnvironment, fromdocname: str, builder: sphinx.builders.Builder, typ: str, target: str, node: sphinx.addnodes.pending_xref, contnode: docutils.nodes.Element) → docutils.nodes.Element | None

Resolve a cross-reference for configuration directives.

A signature may be prefixed with ‘~’ to indicate a shortened text.

resolve_any_xref(env: sphinx.environment.BuildEnvironment, fromdocname: str, builder: sphinx.builders.Builder, target: str, node: sphinx.addnodes.pending_xref, contnode: docutils.nodes.Element) → list[tuple[str, docutils.nodes.Element]]

Resolve a cross-reference without a specified type.