Enable doctesting of ReST docs with `make doctest`.

[dunshire.git] / doc / source / conf.py

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 673323100730a2185be349bda90b96759b8f03da..63ffa74cf3ee48390a75559a91d6002c92e3d55c 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -16,7 +16,7 @@ sys.path.insert(0, os.path.abspath('../../src/dunshire'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
-    'sphinx.ext.coverage',
+    'sphinx.ext.doctest',
     'sphinx.ext.napoleon',
     'sphinx.ext.pngmath',
     'sphinx.ext.viewcode',
@@ -24,6 +24,12 @@ extensions = [
 
 autosummary_generate = True
 
+# Don't automatically test every >>> block in the documentation. This
+# avoids testing the API docs as part of the documentation build,
+# which is exactly what we intend, because those are tested as part of
+# the (much faster) unittest test suite.
+doctest_test_doctest_blocks = ''
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']