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

Notebook documentation #218

Merged
merged 4 commits into from
Feb 27, 2023
Merged

Notebook documentation #218

merged 4 commits into from
Feb 27, 2023

Conversation

ebezzi
Copy link
Member

@ebezzi ebezzi commented Feb 23, 2023

Adds notebook based documentation. Uses a Sphinx extension named nbsphinx that can convert ipynb notebooks into rst files at build time.

Note that the notebooks are symlinked, so any change to a notebook will also be reflected in the docs automatically. This has the advantage of not having to modify extra files, but the drawback is that the examples cannot be manually edited. If this isn't desirable, we can use pandoc to convert the notebooks to static rst files and just include them as part of the documentation sources.

@codecov
Copy link

codecov bot commented Feb 23, 2023

Codecov Report

Merging #218 (fa17ed5) into main (32ea406) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #218   +/-   ##
=======================================
  Coverage   81.87%   81.87%           
=======================================
  Files          28       28           
  Lines        1572     1572           
=======================================
  Hits         1287     1287           
  Misses        285      285           
Flag Coverage Δ
unittests 81.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ebezzi ebezzi merged commit c154d4b into main Feb 27, 2023
@ebezzi ebezzi deleted the ebezzi/notebooks-docs branch February 27, 2023 18:41
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.

2 participants