module documentation

The reStructuredText domain.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable dir​_sig​_re Undocumented
Variable logger Undocumented
Class ​Re​STDirective Description of a reST directive.
Class ​Re​STDirective​Option Description of an option for reST directive.
Class ​Re​STDomain ReStructuredText domain.
Class ​Re​STMarkup Description of generic reST markup.
Class ​Re​STRole Description of a reST role.
Function parse​_directive Parse a directive signature.
Function setup Undocumented
dir_sig_re =

Undocumented

logger =

Undocumented

def parse_directive(d):

Parse a directive signature.

Returns (directive, arguments) string tuple. If no arguments are given, returns (directive, '').

Parameters
d:strUndocumented
Returns
Tuple[str, str]Undocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented