How do I get Sphinx to test code embedded in documentation?
-
19-09-2019 - |
Question
If this code is a blockquote in my documentation, what do I need to do to make Sphinx run it when the documentation is generated? I tried adding
.. testcode::
import datetime
def today():
return datetime.datetime.now().date()
if True:
today()
to one of the .rst
sources and the Sphinx doctest extension to conf.py
, but I got an error complaining about unexpected indentation on the first line of the function body. Is Sphinx's doctest able to run functions defined in the documentation?
Solution
The testcode
directive needs a matching testoutput
directive.
Here's the example from the documentation.
.. testcode::
print 'Output text.'
.. testoutput::
:hide:
:options: -ELLIPSIS, +NORMALIZE_WHITESPACE
Output text.
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow