Adds how to use and configuration for jupytext

dpshelio · dpshelio · commit c0d2ee361788 · 2023-09-22T11:56:04.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -7,11 +7,32 @@ workflow/
 vendor/
 .sconsign.dblite
 html/index.html
-pdf
+*pdf
 *.pyc
+*.ipynb
 *.nbconvert.ipynb
 *.swp
+*.html
+*.mp4
 a.out
+ch00*/learning_git
+ch00*/somefile.md
+ch01*/fourteen.py
+ch01*/draw*
+ch02*/my*
+ch02*/maze*
+ch02*/*csv
+ch02*/*png
+ch02*/greengraph
+ch03*/DiffusionExample
+ch03*/commands
+ch03*/diffusion
+ch03*/saskatchewan
+ch03*/solutions*
+ch04*/greetings*
+ch04*/maze*
+ch08*/*png
+ch98*/*png
 html/reveal/.DS_Store
 html/reveal/assets/night-ucl-overlay.css
 html/reveal/assets/solarized-ucl-overlay.css
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ You are required to bring your own laptop to the course as the classrooms we are
 
 # Contributing to this repository
 
-This repository contains the course notes as jupyter notebooks. This makes it a bit difficult to contribute and to review contributions. Please, only include changes in the cells modified and not other metadata that changes when running them.
+This repository contains the course notes as Jupyter notebooks converted into `py:percent` format. This allows to edit the files as plain text as well as jupyter notebooks. To edit them as jupyter notebooks you'll need to have installed jupytext and open the `ipynb.py` files as notebooks via right-click and select "open with" and "notebook" on the Jupyter file browser.
 
 ⚠ Do not run `make` locally on your computer! ⚠ 
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,3 @@
+[tool.jupytext]
+formats = "ipynb,py:percent"
+notebook_metadata_filter="kernelspec,jupytext,jekyll"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[tool.jupytext]`
	`2`	`+formats = "ipynb,py:percent"`
	`3`	`+notebook_metadata_filter="kernelspec,jupytext,jekyll"`