Merge branch 'main' into readthedocs_branch

Author: enryH

.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

.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"

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