Skip to content
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

Strip notebook output and switch to testing notebooks with docs #4820

Draft
wants to merge 26 commits into
base: develop
Choose a base branch
from

Conversation

kratman
Copy link
Contributor

@kratman kratman commented Feb 6, 2025

Description

Changes:

  • Strips notebook output for easier review. Pre-commit will remove notebook output so that review are easier and unmodified notebooks will not show up as changes in PRs.
  • Switches from nbmake and nbsphinx to myst_nb
  • Runs notebooks in documentation instead of in the example notebooks job

Breaking changes:

  • myst_nb is not compatible with the prolog message used for Google Colab links in the notebooks. I think we should probably just remove the Google Colab parts, but that is not done here.

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@kratman kratman self-assigned this Feb 6, 2025
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@kratman kratman marked this pull request as ready for review February 6, 2025 21:32
Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (f3e9c83) to head (416f7c2).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4820   +/-   ##
========================================
  Coverage    98.70%   98.70%           
========================================
  Files          303      303           
  Lines        23312    23312           
========================================
  Hits         23009    23009           
  Misses         303      303           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kratman kratman marked this pull request as draft February 11, 2025 15:52
@kratman
Copy link
Contributor Author

kratman commented Feb 11, 2025

The hold-up on this one is a timeout in the read-the-docs build from running all the notebooks. I have a workaround for it, but have not pushed it yet

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.

1 participant