Skip to content

add myst notebook representation of examples #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 18, 2022
Merged

add myst notebook representation of examples #283

merged 3 commits into from
Feb 18, 2022

Conversation

OriolAbril
Copy link
Member

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.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@OriolAbril
Copy link
Member Author

Discussed that with @martinacantaro and @drbenvincent in the docs meeting and decided to go ahead with this.

@OriolAbril OriolAbril merged commit c142ef4 into main Feb 18, 2022
@OriolAbril OriolAbril deleted the jupytext branch February 18, 2022 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant