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

Add demo notebooks to docs #56

Merged
merged 2 commits into from
Jun 23, 2023
Merged

Add demo notebooks to docs #56

merged 2 commits into from
Jun 23, 2023

Conversation

angus-g
Copy link
Collaborator

@angus-g angus-g commented Jun 23, 2023

Uses nbsphinx like COSIMA Recipes, but a bit more stripped down. Hopefully it'll just work as expected!

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Jun 23, 2023

Codecov Report

Merging #56 (f934e8d) into main (663b5f3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   10.72%   10.72%           
=======================================
  Files           2        2           
  Lines         429      429           
=======================================
  Hits           46       46           
  Misses        383      383           

@angus-g angus-g linked an issue Jun 23, 2023 that may be closed by this pull request
@navidcy navidcy self-requested a review June 23, 2023 03:04
@navidcy navidcy added the documentation 📔 Improvements or additions to documentation label Jun 23, 2023
Copy link
Contributor

@navidcy navidcy left a comment

Choose a reason for hiding this comment

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

This looks great!

@angus-g angus-g merged commit 7fb6995 into main Jun 23, 2023
@angus-g angus-g deleted the notebook-docs branch June 23, 2023 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include demo.ipynb as part of the docs
2 participants