Skip to content

Commit

Permalink
docs: enable early abort on example error
Browse files Browse the repository at this point in the history
  • Loading branch information
MarieS-WiMLDS committed Jan 22, 2025
1 parent d683ca7 commit edf1e57
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
7 changes: 1 addition & 6 deletions sphinx/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

html_abort_on_example_error:
$(SPHINXBUILD) -D abort_on_example_error=1 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1 change: 1 addition & 0 deletions sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ def reset_mpl(gallery_conf, fname):
"doc_module": "skore",
"default_thumb_file": "./_static/images/[email protected]",
"reset_modules": (reset_mpl, "seaborn"),
"abort_on_example_error": True,
}

# intersphinx configuration
Expand Down

0 comments on commit edf1e57

Please sign in to comment.