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.
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.