Skip to content

Commit de3c3e0

Browse files
Add option to fail docs build on gallery example execution error (#256)
# References and relevant issues Closes napari/napari#6392 Depends on #255 # Description Added a sphinx gallery option to fail the docs build on example execution failure. Right now, this _should_ fail on CI due to one of our example failing, but the docs build will anyway depend on the #255. Co-authored-by: Peter Sobolewski <[email protected]>
1 parent d3b9b68 commit de3c3e0

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,8 @@ def napari_scraper(block, block_vars, gallery_conf):
254254
'plot_gallery': "'True'", # https://github.com/sphinx-gallery/sphinx-gallery/pull/304/files
255255
'download_all_examples': False,
256256
'min_reported_time': 10,
257-
'only_warn_on_example_error': True,
257+
'only_warn_on_example_error': False,
258+
'abort_on_example_error': True,
258259
'image_scrapers': ("matplotlib", napari_scraper,),
259260
'reset_modules': (reset_napari,),
260261
'reference_url': {'napari': None},

0 commit comments

Comments
 (0)