Merge pull request #3619 from zm711/rtd-fail

Switch RTD build to fail on gallery example failure
SpikeInterface · Jan 14, 2025 · 01d1479 · 01d1479
2 parents 8534d8a + 9becf1e
commit 01d1479
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/conf.py b/doc/conf.py
@@ -119,7 +119,9 @@
 
 # for sphinx gallery plugin
 sphinx_gallery_conf = {
-    'only_warn_on_example_error': True,
+    # This is the default but including here explicitly. Should build all docs and fail on gallery failures only.
+    # other option would be abort_on_example_error, but this fails on first failure. So we decided against this.
+    'only_warn_on_example_error': False,
     'examples_dirs': ['../examples/tutorials'],
     'gallery_dirs': ['tutorials' ],  # path where to save gallery generated examples
     'subsection_order': ExplicitOrder([