update

.github/workflows/docker-image.yml

@@ -1,4 +1,4 @@
-name: Docker Image CI
+name: Docker Image Build and Push to Docker Hub
 
 on:
   workflow_dispatch:

.github/workflows/gh-pages.yml

@@ -0,0 +1,57 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy Documentation to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install sphinx pydata-sphinx-theme myst-parser sphinx-copybutton
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Build with Sphinx
+        run: |
+          sphinx-apidoc -f -o docs .
+          sphinx-build -b html docs html
+      - name: Add .nojekyll
+        run: echo "" > html/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pytest.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
     - uses: actions/checkout@v4
@@ -37,4 +37,4 @@ jobs:
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        pytest -W error --durations=10 --durations-min=1.0 tests/
+        pytest -c pytest.ini --durations=10 --durations-min=1.0 tests/

.python-version

@@ -0,0 +1 @@
+3.12

README.md

@@ -17,17 +17,20 @@ A template repository for linting, testing, GUI building and dockerizing python
 - Replace lines 10 - 13 and write your gui in `gui/streamlit_app.py`.
 - Replace lines 3 - 6 and write tests in `tests/test_main.py`.
 - Add your requirements to `requirements.txt`.
-- Document your script with [Sphinx](https://www.sphinx-doc.org/):
-  - Install Sphinx and the [PyData](https://github.com/pydata/pydata-sphinx-theme) theme: `pip install sphinx pydata-sphinx-theme`.
-  - Adjust the configuration to your needs in `docs_src/conf.py`.
-  - Write documentation!
-  - Build documentation with:
-    ```
-    sphinx-apidoc -f -o docs_src .
-    sphinx-build -b html docs_src docs
-    ```
-  - Publish documentation [optional]!
-    - Serving with GitHub pages needs the addition of an empty `.nojekyll` file to your `/docs`.
+- Document your script using the [numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html) and [Sphinx](https://www.sphinx-doc.org/):
+  - Adjust the configuration to your needs in `docs/conf.py`.
+  - Automatically via GitHub Actions:
+    - In the repository go to `Settings` ➡️ `Pages` ➡️ `Build and deployment` ➡️ `Source` ➡️ `GitHub Actions`.
+    - Select the `gh-pages.yml` / `Deploy Documentation to Pages` workflow.
+  - Or build manually:
+    - Install Sphinx and the [PyData](https://github.com/pydata/pydata-sphinx-theme) theme: `pip install sphinx pydata-sphinx-theme`.
+    - Build documentation with:
+      ```
+      sphinx-apidoc -f -o docs .
+      sphinx-build -b html docs html
+      ```
+    - Publish documentation [optional]!
+    - Serving with GitHub pages needs the addition of an empty `.nojekyll` file to your `/html`.
 - Adjust this `README.md` to your needs!
 
 ## Known Issues