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 | 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 |
Undocumented
Parameters | |
env:BuildEnvironment | Undocumented |
textnodes:Iterable[ | Undocumented |
index_key:str | Undocumented |
source:str | Undocumented |
lineno:int | Undocumented |
node_id:str | Undocumented |
document:nodes.document | Undocumented |
Returns | |
nodes.term | Undocumented |
Undocumented
Parameters | |
line:str | Undocumented |
Returns | |
List[ | Undocumented |
Undocumented
Parameters | |
text:str | Undocumented |
productionGroup:str | Undocumented |
Returns | |
List[ | Undocumented |
Undocumented
Parameters | |
app:Sphinx | Undocumented |
domain:Domain | Undocumented |
node:pending_xref | Undocumented |
Returns | |
Optional[ | Undocumented |