sphinx.directives

package documentation
(source)

Handlers for additional ReST directives.

Module code No module docstring; 0/1 variable, 0/3 function, 3/4 classes documented
Module other No module docstring; 0/2 variable, 0/2 function, 9/9 classes documented
Module patches No module docstring; 0/1 variable, 0/1 function, 3/4 classes documented

From __init__.py:

Class DefaultDomain Directive to (re-)set the default domain for this source file.
Class DefaultRole Set the default interpreted text role. Overridden from docutils.
Class ObjectDescription Directive to describe a class, function or similar object. Not used directly, but subclassed (in domain-specific directives) to add custom behavior.
Function optional_int Check for an integer argument or None value; raise ``ValueError`` if not.
Function setup Undocumented
Type Variable T Undocumented
Variable nl_escape_re Undocumented
Variable strip_backslash_re Undocumented
nl_escape_re = (source)

Undocumented

strip_backslash_re = (source)

Undocumented

T = (source)

Undocumented

Value
TypeVar('T')
def optional_int(argument): (source)

Check for an integer argument or None value; raise ``ValueError`` if not.

Parameters
argument:strUndocumented
Returns
int|NoneUndocumented
def setup(app): (source)

Undocumented

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