add myst notebook representation of examples #283
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.
As we start taking advantage of more and more myst features, the reviewnb representation of
the notebooks becomes more and more limited. I think we should keep it because it is useful
to see a diff with outputs, but the content diffs are often wrong (i.e. if adding backticks
for code formatting), tags and metadata is not shown anywhere (and we use that for myst
substitutions, hiding cells, rendering code generated images as figures...).
Having a myst representation of the notebooks solves this problem. I am also adding
jupytext as a pre-commit hook to make sure ipynb and .myst.md files always stay synced.