sphinx.domains.std

module documentation
(source)

The standard domain.

Class Cmdoption Description of a command-line option (.. option).
Class EnvVar Undocumented
Class EnvVarXRefRole Cross-referencing role for environment variables (adds an index entry).
Class GenericObject A generic x-ref directive registered with Sphinx.add_object_type().
Class Glossary Directive to create a glossary with cross-reference targets for :term: roles.
Class OptionXRefRole Undocumented
Class ProductionList Directive to list grammar productions.
Class Program Directive to name the program for which options are documented.
Class StandardDomain Domain for all objects that don't fit into another domain or are added via the application interface.
Class Target Generic target for user-defined cross-reference types.
Class TokenXRefRole Undocumented
Function make_glossary_term Undocumented
Function setup Undocumented
Function split_term_classifiers Undocumented
Function token_xrefs Undocumented
Function warn_missing_reference Undocumented
Variable logger Undocumented
Variable option_desc_re Undocumented
Variable samp_role Undocumented
Variable token_re Undocumented
def make_glossary_term(env, textnodes, index_key, source, lineno, node_id, document): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
textnodes:Iterable[Node]Undocumented
index_key:strUndocumented
source:strUndocumented
lineno:intUndocumented
node_id:str|NoneUndocumented
document:nodes.documentUndocumented
Returns
nodes.termUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
def split_term_classifiers(line): (source)

Undocumented

Parameters
line:strUndocumented
Returns
list[str|None]Undocumented
def token_xrefs(text, productionGroup=''): (source)

Undocumented

Parameters
text:strUndocumented
productionGroup:strUndocumented
Returns
list[Node]Undocumented
def warn_missing_reference(app, domain, node): (source)

Undocumented

Parameters
app:SphinxUndocumented
domain:DomainUndocumented
node:pending_xrefUndocumented
Returns
bool|NoneUndocumented
logger = (source)

Undocumented

option_desc_re = (source)

Undocumented

samp_role = (source)

Undocumented

token_re = (source)

Undocumented