Skip to content

Sheshuk/fix model notebooks #402

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.

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

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Conversation

Sheshuk
Copy link
Contributor

@Sheshuk Sheshuk commented Jul 4, 2025

Closes #392 , #223

Trying to fix the remaining issues with building the notebooks:

Also, currently building the notebooks in the docs is not very informative: if one fails, we don't get any additional information. I'm adding a separate step, calling the pytest on notebooks, so we can see exctly which ones of them are failed, instead of exit on first failure.

@JostMigenda
Copy link
Member

[ ] Errors in AnalyticFluence - it's incompatible with our ccsn_loaders.

In #404, @jpkneller suggested (among other things) moving that class from ccsn.py to base.py. So we could leave this particular issue for that PR and don’t have to deal with it here.

@@ -79,6 +79,7 @@
# directories to ignore when looking for source files.
exclude_patterns = ['nb/dev']

nbsphinx_allow_errors = True
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’d like to be very strict here, because any errors that slip through will make it to the published documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is still strict: I've added the pytest --nbval step, so we're still having the notebooks checked, but it provides more information: instead of just failing on the first failed notebook during the documentation build, it will run each of them as test and give the output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review & Update the usage examples' notebooks
2 participants