how to format notebooks

coderefinery · Jan 27, 2025 · 6b01baf · 6b01baf
1 parent bd60507
commit 6b01baf
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 1 deletion.
diff --git a/content/index.md b/content/index.md
@@ -65,7 +65,7 @@ them to own projects**.
 
 - 12:45-13:30 - Working with Notebooks
   - Notebooks and version control
-  - Other tooling
+  - {doc}`notebooks/tooling`
   - {doc}`notebooks/sharing`
 
 - 13:30-14:15 - Other useful tools for Python development
@@ -128,6 +128,7 @@ documentation
 collaboration
 dependencies
 testing
+notebooks/tooling
 notebooks/sharing
 refactoring-concepts
 good-practices

diff --git a/content/notebooks/button.jpg b/content/notebooks/button.jpg
diff --git a/content/notebooks/packages.jpg b/content/notebooks/packages.jpg
diff --git a/content/notebooks/tooling.md b/content/notebooks/tooling.md
@@ -0,0 +1,25 @@
+# Other useful tooling for notebooks
+
+
+## Code formatting
+
+<https://jupyterlab-code-formatter.readthedocs.io/>
+
+
+:::{figure} packages.jpg
+:alt: Screenshot of three additional packages in environment.yml
+
+We need three additional packages to format code in JupyterLab: `jupyterlab-code-formatter`, `black`, and `isort`.
+:::
+
+
+:::{figure} button.jpg
+:alt: Screenshot of the button to format code in JupyterLab
+
+This button will format the code in all cells of the notebook.
+:::
+
+
+:::{instructor-note}
+We test it out together on an example notebook.
+:::