docs: add Jupyter notebook example #65
Merged
Conversation
This file contains 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
Also added doc8 to requirements
Codecov Report
@@ Coverage Diff @@
## master #65 +/- ##
==========================================
- Coverage 58.03% 57.95% -0.09%
==========================================
Files 13 13
Lines 510 509 -1
==========================================
- Hits 296 295 -1
Misses 214 214
|
|
Changing this PR back to draft status, because I can't get nbsphinx to work properly... |
|
Notebook output seems to render correctly now on RTD Only Travis is complaining now... |
spflueger
requested changes
May 11, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently only added a notebook that illustrates how to generate data samples, but this can be extended by simply adding more notebooks in the
examples/jupyterfolder.Current output on RTD can be viewed at
https://pwa.readthedocs.io/projects/tensorwaves/en/notebooks/usage.html