sphinx.directives

package documentation

Handlers for additional ReST directives.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Module code sphinx.directives.code ~~~~~~~~~~~~~~~~~~~~~~
Module other sphinx.directives.other ~~~~~~~~~~~~~~~~~~~~~~~
Module patches sphinx.directives.patches ~~~~~~~~~~~~~~~~~~~~~~~~~

From __init__.py:

Class ​Object​Description Directive to describe a class, function or similar object. Not used directly, but subclassed (in domain-specific directives) to add custom behavior.
Constant T Undocumented
Variable nl​_escape​_re Undocumented
Variable strip​_backslash​_re Undocumented
Class ​Default​Domain Directive to (re-)set the default domain for this source file.
Class ​Default​Role Set the default interpreted text role. Overridden from docutils.
Function optional​_int Check for an integer argument or None value; raise ValueError if not.
Function setup Undocumented
nl_escape_re =

Undocumented

strip_backslash_re =

Undocumented

T =

Undocumented

Value
TypeVar('T')
def optional_int(argument):
Check for an integer argument or None value; raise ValueError if not.
Parameters
argument:strUndocumented
Returns
intUndocumented
def setup(app):

Undocumented

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