DOCS: Skip execution of some examples #220
Merged
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 reworks the way the doc was previously created by adding a few steps.
The main change is that we are manually using
jupytext
to create the notebooks while we were delegating that previously.While see could seem like a trivial change, it provides us the opportunity to then extend the metadata associated to the notebook while previously it was executed on the fly without us being able to add metadata.
Now, after the creation of the notebook, we disable some examples execution by adding this to the notebook’s JSON metadata:
Note: Now that we have something working, it might have been possible to simply add a unique event hook at readtime to add the previously mentioned metadata. However, I'm not sure to how easy this would be as we are not directly the one "playing" with the file content. I might rework that in a future PR to simplify things.