Add notebooks to docs#142
Merged
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #142 +/- ##
==========================================
- Coverage 75.17% 74.83% -0.35%
==========================================
Files 29 29
Lines 1112 1089 -23
==========================================
- Hits 836 815 -21
+ Misses 276 274 -2
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
Contributor
Author
|
...I have not yet managed to get this working... |
… problem with creating env on readthedocs
Contributor
Author
|
Current status: One notebook is already correctly shown in the docs TODO:
|
3 tasks
Contributor
Author
|
After just 2 years 🐌 this is now done 🎉 . All notebooks (I hope I did not miss one) are now rendered in the docs. What remains as TODO is to clean-up and potentially restructure the notebooks, see #170. |
cchwala
added a commit
that referenced
this pull request
Oct 9, 2025
We need this because the PDF build fails and we do not care about the PDF or epub build. Note that this only seems to affect the builds done of the master branch and not the PR builds of the docs which apparently only build the html version of the docs (which makes sense for a PR docs build which is used for debugging). Hence we did not see this problem occur in #142. I hope this solved the issue with the current main readthedocs build.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
According to the documentation of readthedosc here it should be super easy to add the rendered notebooks in our docs. This PR tries to do just that.
This will close #144.