-
Notifications
You must be signed in to change notification settings - Fork 988
Readthedocs: Don't let notebook failures pass silently #2276
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Conversation
Performance benchmarks:
|
Yeah apparently that's not a thing. Filed an upstream question: |
The very friendly maintainers of myst-nb pointed me to these docs, which contained the answer. When an error is introduced, the build now fails as expected: |
6408f21
to
ca8b6d3
Compare
@wang-boyu @adamamer20 I high recommend enabling this also for Mesa-geo and Mesa-frames. |
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
ca8b6d3
to
34b6518
Compare
Performance benchmarks:
|
that's very useful. I am using a markdown file for the tutorial currently but I need to turn it into a jupyter file. This option is supported into mkdocs-jupyter too |
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
) 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
Adds both to
docs/conf.py
: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.
Closes #2270.