Include examples as notebooks in the documentation #197
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.
This PR uses
nbsphinx
so that we can use notebooks as source files in the Sphinx documentation.The notebooks are then nicely formatted in the chosen style of the documentation. In addition, they are run by
readthedocs
as part of building the documentation - which provides one form of automatic testing. (The readthedocs build will fail if the notebook is obsolete and does not work anymore.)In particular, our first example (gaussian laser) has now been converted in notebook format.
Future PRs will add more notebooks in the
tutorials
folder.