Skip to content

Commit 01d1479

Browse files
authored
Merge pull request #3619 from zm711/rtd-fail
Switch RTD build to fail on gallery example failure
2 parents 8534d8a + 9becf1e commit 01d1479

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

doc/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@
119119

120120
# for sphinx gallery plugin
121121
sphinx_gallery_conf = {
122-
'only_warn_on_example_error': True,
122+
# This is the default but including here explicitly. Should build all docs and fail on gallery failures only.
123+
# other option would be abort_on_example_error, but this fails on first failure. So we decided against this.
124+
'only_warn_on_example_error': False,
123125
'examples_dirs': ['../examples/tutorials'],
124126
'gallery_dirs': ['tutorials' ], # path where to save gallery generated examples
125127
'subsection_order': ExplicitOrder([

0 commit comments

Comments
 (0)