Use jupyter-input directive for cells that should not be run #74
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
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.
We had some code blocks in the docs containing only commented-out code. The reason for having these was to show the code in the docs, but we didn't want these blocks to run because they produce data files. I don't remember why exactly producing those data files was a problem.
When I worked on this 2 years ago, I read that a new version of
jupyter-sphinxwould feature a solution: a directive to just show the code as an input cell, without executing it. This commit was just waiting for that new version, which is out by now (and has been for quite some time, I imagine).