sphinx.ext.doctest

module documentation

Mimic doctest by automatically executing code snippets and checking their results.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Variable	`blankline_re`	Undocumented
Variable	`doctestopt_re`	Undocumented
Variable	`logger`	Undocumented
Variable	`parser`	Undocumented
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

blankline_re =

Undocumented

doctestopt_re =

Undocumented

logger =

Undocumented

parser =

Undocumented

def is_allowed_version(spec, version):

Check spec satisfies version or not.

Some examples:

>>> is_allowed_version('3.3', '<=3.5')
True
>>> is_allowed_version('3.3', '<=3.2')
False
>>> is_allowed_version('3.3', '>3.2, <4.0')
True

def setup(app):

Undocumented