3.4. sphinx.ext.doctest

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

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

3.4.1. Functions

bold(text)
doctest_encode(text, encoding)
force_decode(string, encoding) Forcibly get a unicode string out of a bytestring.
itervalues(d, **kw) Return an iterator over the values of a dictionary.
set_source_info(directive, node)
setup(app)

3.4.2. Classes

Builder(app) Builds target formats from the reST sources.
Directive(name, arguments, options, content, ...) Base class for reStructuredText directives.
DocTestBuilder(app) Runs test snippets in the documentation.
DoctestDirective(name, arguments, options, ...)
SphinxDocTestRunner([checker, verbose, ...])
StringIO([buf]) class StringIO([buffer])
TestCode(code, type, lineno[, options])
TestDirective(name, arguments, options, ...) Base class for doctest-related directives.
TestGroup(name)
TestcleanupDirective(name, arguments, ...)
TestcodeDirective(name, arguments, options, ...)
TestoutputDirective(name, arguments, ...)
TestsetupDirective(name, arguments, options, ...)
binary_type alias of str
text_type alias of unicode