orangeqs.juice._sphinx._reference

Module Contents

Functions

parse_schema_reference	Parse a schema reference signature.
parse_field_reference	Parse a field reference signature.

API

orangeqs.juice._sphinx._reference.parse_schema_reference(signature: str) → tuple[str, tuple[str, str], str]

Parse a schema reference signature.

Parameters

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

Returns

• (str): A descriptive name of the reference.

• (tuple[str, str]): The regular and shortened text for the reference.

• (str): The link anchor for the reference.

orangeqs.juice._sphinx._reference.parse_field_reference(signature: str) → tuple[str, tuple[str, str], str]

Parse a field reference signature.

Parameters

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

Returns

• (str): A descriptive name of the reference.

• (tuple[str, str]): The regular and shortened text for the reference.

• (str): The link anchor for the reference.