Skip to content
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

Use jupytext for notebooks in the documentation? #2099

Closed
kosack opened this issue Oct 19, 2022 · 2 comments
Closed

Use jupytext for notebooks in the documentation? #2099

kosack opened this issue Oct 19, 2022 · 2 comments

Comments

@kosack
Copy link
Contributor

kosack commented Oct 19, 2022

Please describe the use case that requires this feature.

Looking at diffs and quickly updating notebooks in the docs currently requires external tools like nbdime or Review Notebook App due to the fact that the *.ipynb format is JSON-based. JSON is also not very GIT-friendly.

Describe the solution you'd like

jupytext (https://jupytext.readthedocs.io) solves this by using a line-based format for notebooks (basically a python script with special comments to store the metadata or a markdown file with similar).

It would be nice to use this and migrate the current docs to this format.

Disadvantage: It would add one more dependency on the jupytext package for documentation building, and would also require anyone using the notebooks outside of the docs to install this plugin. Also, not sure that GitHub auto-renders jupytext docs, probably not, except if the MarkDown version is used (but in any case viewing in GitHub may not be a big problem as the docs are rendered to readthedocs)

@vuillaut
Copy link
Member

I was going to write that an additional potential drawback is the inability to run on mybinder, but it's actually possible:
https://jupytext.readthedocs.io/en/latest/faq.html?highlight=binder#can-i-use-jupytext-with-jupyterhub-binder-nteract-colab-saturn-or-azure
👍

@maxnoe
Copy link
Member

maxnoe commented Oct 21, 2023

Done in #2377

@maxnoe maxnoe closed this as completed Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants