Introduce notebooks to documentation. #205
Merged
Conversation
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
eccles
force-pushed
the
dev/eccles/embed-notebook-into-docs
branch
9 times, most recently
from
932b467 to
5f757c0
Compare
Problem: Example code is formatted and statically checked but not tested if correct. Solution: Notebooks have been introduced as a way of demonstrating correctness of example code. These notebooks will now replace example code in the documentation and will be tested. This change implements one notebook and ensures that this is tested correctly and can be downloaded and executed by a customer. The notebooks can be downloaded as a zip file and can be executed by the user on her local development system. Some notebooks already present are left untouched. Signed-off-by: Paul Hewlett <phewlett76@gmail.com>
eccles
force-pushed
the
dev/eccles/embed-notebook-into-docs
branch
from
5f757c0 to
3661d2a
Compare
eccles
requested review from
CamrynCarter,
Glitch3001,
JAG-UK,
Serhiy1,
honourfish,
j-hartley,
landintrees,
mmwilder26 and
xilix
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.
Problem:
Example code is formatted and statically checked but not tested if correct.
Solution:
Notebooks have been introduced as a way of demonstrating correctness of example code. These notebooks will now replace example code in the documentation and will be tested.
This change implements one notebook and ensures that this is tested correctly and can be downloaded and executed by a customer.
The notebooks can be downloaded as a zip file and can be executed by the
user on her local development system.
Some notebooks already present are left untouched.
Signed-off-by: Paul Hewlett phewlett76@gmail.com