module documentation

The standard domain.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Variable option​_desc​_re Undocumented
Variable token​_re Undocumented
Class ​Cmdoption Description of a command-line option (.. option).
Class ​Env​Var Undocumented
Class ​Env​Var​XRef​Role Cross-referencing role for environment variables (adds an index entry).
Class ​Generic​Object 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 ​Option​XRef​Role Undocumented
Class ​Production​List Directive to list grammar productions.
Class ​Program Directive to name the program for which options are documented.
Class ​Standard​Domain 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 ​Token​XRef​Role Undocumented
Function make​_glossary​_term Undocumented
Function setup Undocumented
Function split​_term​_classifiers Undocumented
Function token​_xrefs Undocumented
Function warn​_missing​_reference Undocumented
logger =

Undocumented

option_desc_re =

Undocumented

token_re =

Undocumented

def make_glossary_term(env, textnodes, index_key, source, lineno, node_id, document):

Undocumented

Parameters
env:BuildEnvironmentUndocumented
textnodes:Iterable[Node]Undocumented
index​_key:strUndocumented
source:strUndocumented
lineno:intUndocumented
node​_id:strUndocumented
document:nodes.documentUndocumented
Returns
nodes.termUndocumented
def setup(app):

Undocumented

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

Undocumented

Parameters
line:strUndocumented
Returns
List[Optional[str]]Undocumented
def token_xrefs(text, productionGroup=''):

Undocumented

Parameters
text:strUndocumented
production​Group:strUndocumented
Returns
List[Node]Undocumented
def warn_missing_reference(app, domain, node):

Undocumented

Parameters
app:SphinxUndocumented
domain:DomainUndocumented
node:pending_xrefUndocumented
Returns
Optional[bool]Undocumented