removing jupytext redundant markdown copies of notebooks, more work t…

…han worth
mfinzi · Mar 8, 2021 · 1f2fc4f · 1f2fc4f
1 parent 89f26be
commit 1f2fc4f
Show file tree

Hide file tree

Showing 9 changed files with 4 additions and 730 deletions.
diff --git a/docs/documentation.md b/docs/documentation.md
@@ -15,12 +15,8 @@ sphinx-build -b html -D jupyter_execute_notebooks=off docs docs/build/html
 ```
 You can then see the generated documentation in `docs/build/html/index.html`.
 
-## Update notebooks
+### Update notebooks
 We follow the approach of [Jax](https://jax.readthedocs.io/) in how the documentation is setup and how to contribute.
-We use [jupytext](https://jupytext.readthedocs.io/) to maintain two synced copies of the notebooks
-in `docs/notebooks`: one in `ipynb` format, and one in `md` format. The advantage of the former
-is that it can be opened and executed directly in Colab; the advantage of the latter is that
-it makes it much easier to track diffs within version control.
 
 ### Editing ipynb
 
@@ -29,18 +25,4 @@ edit the notebooks in Jupyter or in Colab. To edit notebooks in the Colab interf
 open <http://colab.research.google.com> and `Upload` from your local repo.
 Update it as needed, `Run all cells` then `Download ipynb` (for editing and running in Colab you will need to add 
 `!pip install git+https://github.com/mfinzi/equivariant-MLP.git`).
-You may want to test that it executes properly, using `sphinx-build` as explained above.
-
-### Editing md
-
-For making smaller changes to the text content of the notebooks, it is easiest to edit the
-`.md` versions using a text editor.
-
-### Syncing notebooks
-
-After editing either the ipynb or md versions of the notebooks, you can sync the two versions
-using [jupytext](https://jupytext.readthedocs.io/) by running:
-
-```
-$ jupytext --sync docs/notebooks/*
-```
+You may want to test that it executes properly, using `sphinx-build` as explained above.
diff --git a/docs/manual_make.sh b/docs/manual_make.sh
@@ -1,3 +1,3 @@
 #!/bin/bash
-jupytext --sync ./notebooks/*
+# jupytext --sync ./notebooks/*
 sphinx-build -b html . ./build/html
diff --git a/docs/notebooks/building_a_model.md b/docs/notebooks/building_a_model.md
diff --git a/docs/notebooks/mixed_tensors.md b/docs/notebooks/mixed_tensors.md
diff --git a/docs/notebooks/multilinear_maps.md b/docs/notebooks/multilinear_maps.md