You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
The text was updated successfully, but these errors were encountered:
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)
The text was updated successfully, but these errors were encountered: