New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readthedocs: Don't let notebook failures pass silently #250

Merged

EwoutH merged 1 commit into main from rtd_fail_on_error

Sep 25, 2024

Member

EwoutH commented Sep 25, 2024

Adds both to docs/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 the myst-nb docs and projectmesa/mesa#2276.


          Readthedocs: Don't let notebook failures pass silently

fe8dfac

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

EwoutH added docs ci testing labels

EwoutH merged commit 7a4ce36 into main

9 of 11 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci docs testing