WIP: Using a notebook + nbconvert to execute code blocks #422
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
2 tasks
|
hey @maartenbreddels - looks interesting! Do you think you could give an idea for the main "pros" of doing things this way? E.g., since Sphinx-Gallery already has its own "run the notebook and collect results" script, what would the main benefit be here? Simplification of the build process by offloading onto a dependency? |
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.
This is the initial attempt to use a notebook + nbconvert to produce rich output, as explained in #421. It does not yet do any attempt to make a snapshot of the html or widget output.
I understand the issues with the dependency in nbconvert/nbformat, but this is more of an exploration of what is possible. Note that the dependency could be totally optional.
It renders (most) of the gallery already, except for mayavi:
I added an pandas dataframe example (rendering html) and ipyvolume (rendering a live widget). It would be interesting to connect the widget to a live mybinder kernel!.
Pandas dataframe / html
ipyvolume / ipywidgets
To use notebook+nbconvert you need to set the configuration option:
'executor': 'notebook', and optionally set thejupyter_kernelto something else then the default value of 'python3'.For other languages, such as C++, we need some language specific template that are injected into the notebook for the timing and memory usage.