Example notebooks in the documentation are stored as Jupyter Notebooks.
They have a relatively large footprint on disk and version control is a bit messed up with them since they're one big JSON file with images represented by long binary strings.
One step to improving this is to store notebooks without outputs (i.e., no or minimal binary images).
Another is then to store the notebooks as plain text using jupytext. That way, we get much better quality version control and it is still possible to edit the notebooks as notebooks in e.g. VSCode by using the in-built notebook viewer or a jupytext plugin (e.g., this one). On saving, the plain text (python) files are updated.
This would also allow us to run our spell checker (#88) over the notebooks too.
Problem description
Example notebooks in the documentation are stored as Jupyter Notebooks.
They have a relatively large footprint on disk and version control is a bit messed up with them since they're one big JSON file with images represented by long binary strings.
One step to improving this is to store notebooks without outputs (i.e., no or minimal binary images).
Another is then to store the notebooks as plain text using jupytext. That way, we get much better quality version control and it is still possible to edit the notebooks as notebooks in e.g. VSCode by using the in-built notebook viewer or a jupytext plugin (e.g., this one). On saving, the plain text (python) files are updated.
This would also allow us to run our spell checker (#88) over the notebooks too.
Calliope version
v0.7.0-dev