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

Use nbsphinx to execute demo notebook #125

Merged
merged 3 commits into from
Nov 16, 2022
Merged

Use nbsphinx to execute demo notebook #125

merged 3 commits into from
Nov 16, 2022

Conversation

maxrjones
Copy link
Member

Description of proposed changes

Automatically execute the demo notebook when building the docs.

Fixes #

@codecov-commenter
Copy link

codecov-commenter commented Nov 16, 2022

Codecov Report

Merging #125 (9631e08) into main (f04ad18) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #125   +/-   ##
=======================================
  Coverage   97.97%   97.97%           
=======================================
  Files           5        5           
  Lines         198      198           
  Branches       35       35           
=======================================
  Hits          194      194           
  Misses          4        4           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@andersy005 andersy005 left a comment

Choose a reason for hiding this comment

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

Nice, 👍🏽

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Just some minor comments, otherwise good! For reference, readthedocs build at https://readthedocs.org/projects/xbatcher/builds/18654567/ took 4min 13sec.

doc/conf.py Outdated Show resolved Hide resolved
ci/requirements/doc.yml Outdated Show resolved Hide resolved
@weiji14 weiji14 added the maintenance Maintenance tasks label Nov 16, 2022
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@maxrjones
Copy link
Member Author

Just some minor comments, otherwise good! For reference, readthedocs build at https://readthedocs.org/projects/xbatcher/builds/18654567/ took 4min 13sec.

Thanks Wei Ji! It'll be interesting to see the speedup after fixing #121.

@maxrjones maxrjones merged commit e976d76 into main Nov 16, 2022
@maxrjones maxrjones deleted the nbsphinx-execution branch November 16, 2022 23:19
@maxrjones maxrjones added documentation and removed maintenance Maintenance tasks labels Jan 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants