Skip to content

Commit

Permalink
Readthedocs: Don't let notebook failures pass silently
Browse files Browse the repository at this point in the history
Adds both to conf.py:

nb_execution_allow_errors = False
nb_execution_raise_on_error = True

To make sure that when one of the (tutorial) notebooks fails, the Readthedocs also fails and doesn't continue silently.

See https://myst-nb.readthedocs.io/en/latest/computation/execute.html#error-reporting-warning-vs-failure
  • Loading branch information
EwoutH committed Sep 4, 2024
1 parent 3d19edc commit 34b6518
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@

nb_execution_timeout = 60
nb_execution_mode = "cache"
nb_execution_allow_errors = False
nb_execution_raise_on_error = True

# -- Options for HTML output ----------------------------------------------

Expand Down

0 comments on commit 34b6518

Please sign in to comment.