sphinx.ext.doctest

module documentation
(source)

Mimic doctest in Sphinx. The extension automatically execute code snippets and checks their results.

Class DocTestBuilder Runs test snippets in the documentation.
Class DoctestDirective Undocumented
Class SphinxDocTestRunner Undocumented
Class TestcleanupDirective Undocumented
Class TestCode Undocumented
Class TestcodeDirective Undocumented
Class TestDirective Base class for doctest-related directives.
Class TestGroup Undocumented
Class TestoutputDirective Undocumented
Class TestsetupDirective Undocumented
Function is_allowed_version Check `spec` satisfies `version` or not.
Function setup Undocumented
Variable blankline_re Undocumented
Variable doctestopt_re Undocumented
Variable logger Undocumented
Variable parser Undocumented
def is_allowed_version(spec, version): (source)

Check `spec` satisfies `version` or not. This obeys PEP-440 specifiers: https://peps.python.org/pep-0440/#version-specifiers Some examples: >>> is_allowed_version('<=3.5', '3.3') True >>> is_allowed_version('<=3.2', '3.3') False >>> is_allowed_version('>3.2, <4.0', '3.3') True

Parameters
spec:strUndocumented
version:strUndocumented
Returns
boolUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
blankline_re = (source)

Undocumented

doctestopt_re = (source)

Undocumented

logger = (source)

Undocumented

parser = (source)

Undocumented