From 46314b28d767631c34ea51cd5dfa20f39b8cb3a8 Mon Sep 17 00:00:00 2001
From: Henry Webel <heweb@dtu.dk>
Date: Mon, 24 Nov 2025 12:17:33 +0100
Subject: [PATCH 1/2] :memo: format README and add hint to isort

---
 .github/workflows/README.md |  2 +-
 docs/README.md              | 15 ++++++++-------
 2 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/README.md b/.github/workflows/README.md
index 058b498..020905d 100644
--- a/.github/workflows/README.md
+++ b/.github/workflows/README.md
@@ -4,7 +4,7 @@
 
 Basic continuous integration and deployment (CI/CD) workflow for Python packages.
 
-- checks formatting (black)
+- checks formatting (black, isort)
 - checks linting (ruff)
 - run unit tests (pytest)
 - optional: add c extensions to a package
diff --git a/docs/README.md b/docs/README.md
index db4d22c..2100887 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,10 +1,10 @@
 # Docs creation
 
-In order to build the docs you need to 
+In order to build the docs you need to
 
-  1. install sphinx and additional support packages
-  2. build the package reference files
-  3. run sphinx to create a local html version
+1. install sphinx and additional support packages
+2. build the package reference files
+3. run sphinx to create a local html version
 
 The documentation is build using readthedocs automatically.
 
@@ -17,12 +17,13 @@ pip install ".[docs]"
 
 ## Build docs using Sphinx command line tools
 
-Command to be run from `path/to/docs`, i.e. from within the `docs` package folder: 
+Command to be run from `path/to/docs`, i.e. from within the `docs` package folder:
 
 Options:
-  - `--separate` to build separate pages for each (sub-)module
 
-```bash	
+- `--separate` to build separate pages for each (sub-)module
+
+```bash
 # pwd: docs
 # apidoc
 sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/python_package

From f54dca44d9366a4bf382f037181121810c6e82b7 Mon Sep 17 00:00:00 2001
From: Henry Webel <heweb@dtu.dk>
Date: Mon, 24 Nov 2025 12:20:25 +0100
Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=94=A7=20update=20to=20new=20version?=
 =?UTF-8?q?=20of=20rtd=20default?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .readthedocs.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 29f28ee..686a75e 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -7,9 +7,9 @@ version: 2
 
 # Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.13"
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"