From 4a582c06ad03841e9118fa4b2a6747f2b50dc430 Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 10:40:19 +0200 Subject: [PATCH 01/11] Added gh workflow for building sphinx documentation on each PR update --- .github/workflows/documentation.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..6b89bc32 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,26 @@ +name: "Sphinx: Render docs" + +on: pull_request + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + - name: Build HTML + uses: ammaraskar/sphinx-action@master + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: docs/build/html/ + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/build/html \ No newline at end of file From ff320e478ffb1308d54434e79ff00f62e406411a Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 10:42:22 +0200 Subject: [PATCH 02/11] updated workflow with correct path --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 6b89bc32..cf58c69d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,10 +17,10 @@ jobs: uses: actions/upload-artifact@v4 with: name: html-docs - path: docs/build/html/ + path: doc/build/html/ - name: Deploy uses: peaceiris/actions-gh-pages@v3 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docs/build/html \ No newline at end of file + publish_dir: doc/build/html \ No newline at end of file From d6dad9a0285ea4a3bb7f66df785a51eacd66061e Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 10:45:46 +0200 Subject: [PATCH 03/11] fixed yaml formatting --- .github/workflows/documentation.yml | 32 ++++++++++++++--------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index cf58c69d..04582eb9 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -8,19 +8,19 @@ jobs: permissions: contents: write steps: - - uses: actions/checkout@v4 - with: - persist-credentials: false - - name: Build HTML - uses: ammaraskar/sphinx-action@master - - name: Upload artifacts - uses: actions/upload-artifact@v4 - with: - name: html-docs - path: doc/build/html/ - - name: Deploy - uses: peaceiris/actions-gh-pages@v3 - if: github.ref == 'refs/heads/main' - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: doc/build/html \ No newline at end of file + - uses: actions/checkout@v4 + with: + persist-credentials: false + - name: Build HTML + uses: ammaraskar/sphinx-action@master + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: doc/build/html/ + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: doc/build/html From 0d50ab24f9fb6b7ce8afda7911855bcedade83e3 Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 10:53:14 +0200 Subject: [PATCH 04/11] Updated environment scripts and workflow to setup dependencies --- .github/workflows/documentation.yml | 10 ++++++++++ doc/{create_env.bat => create_venv.bat} | 0 doc/run_spinx.bat | 5 +---- 3 files changed, 11 insertions(+), 4 deletions(-) rename doc/{create_env.bat => create_venv.bat} (100%) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 04582eb9..1c66a988 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -11,8 +11,18 @@ jobs: - uses: actions/checkout@v4 with: persist-credentials: false + - uses: actions/setup-python@v6 + with: + python-version: "3.13" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r doc/requirements.txt + pip install -e . - name: Build HTML uses: ammaraskar/sphinx-action@master + with: + docs-folder: "doc/" - name: Upload artifacts uses: actions/upload-artifact@v4 with: diff --git a/doc/create_env.bat b/doc/create_venv.bat similarity index 100% rename from doc/create_env.bat rename to doc/create_venv.bat diff --git a/doc/run_spinx.bat b/doc/run_spinx.bat index 7ec442ef..b47df5d7 100644 --- a/doc/run_spinx.bat +++ b/doc/run_spinx.bat @@ -4,14 +4,11 @@ setlocal rem Jump to the directory where this script is located (doc\) pushd "%~dp0" -set "PY_BOOTSTRAP=python" -where py >NUL 2>NUL if %ERRORLEVEL% EQU 0 set "PY_BOOTSTRAP=py" if not exist .\venv\Scripts\python.exe ( echo Creating virtual environment... - %PY_BOOTSTRAP% -m venv .\venv - + call create_venv.bat call .\venv\Scripts\activate.bat ) else ( echo Using existing virtual environment... From a637a6013fcf2149fa5c89ead54a48aeba5e7f73 Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 11:26:32 +0200 Subject: [PATCH 05/11] Changed to python 3.11 --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 1c66a988..a6131cb4 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -13,7 +13,7 @@ jobs: persist-credentials: false - uses: actions/setup-python@v6 with: - python-version: "3.13" + python-version: "3.11" - name: Install dependencies run: | python -m pip install --upgrade pip From 52c8d47d0f5fd7adfdd30d4e2b53a8722ee8fd6b Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 11:50:25 +0200 Subject: [PATCH 06/11] Removed unused requirements --- doc/requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index be7c2b81..82dd3a09 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,4 @@ Sphinx>=4.2.0 sphinx-rtd-theme>=1.0.0 sphinxcontrib-bibtex>=2.4.2 -python_docs_theme>=2024.12 furo>=2024.8.6 \ No newline at end of file From de1caf933312882617ca0dd478f7f72722eed92b Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 15:01:40 +0200 Subject: [PATCH 07/11] Updated dependencies for doc build --- doc/requirements.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 82dd3a09..e975fbc4 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ -Sphinx>=4.2.0 -sphinx-rtd-theme>=1.0.0 -sphinxcontrib-bibtex>=2.4.2 -furo>=2024.8.6 \ No newline at end of file +Sphinx~=9.0.4 +sphinx-rtd-theme~=3.1.0 +sphinxcontrib-bibtex~=2.7.0 +furo~=2025.12.19 \ No newline at end of file From 3fa0f723079a3d863642c5e78ae65dcba74fa05f Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 15:05:51 +0200 Subject: [PATCH 08/11] Removed outdated action from workflow --- .github/workflows/documentation.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index a6131cb4..8fc58504 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -20,9 +20,9 @@ jobs: pip install -r doc/requirements.txt pip install -e . - name: Build HTML - uses: ammaraskar/sphinx-action@master - with: - docs-folder: "doc/" + run: | + cd doc + make html - name: Upload artifacts uses: actions/upload-artifact@v4 with: From dece1c4cb2d28afa09d5fb591b088ce2cf33fa4b Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 15:07:41 +0200 Subject: [PATCH 09/11] changed path for artifact packaging --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8fc58504..e48aa69a 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -27,7 +27,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: html-docs - path: doc/build/html/ + path: doc/_build/html/ - name: Deploy uses: peaceiris/actions-gh-pages@v3 if: github.ref == 'refs/heads/main' From e13cfad8b3b05db170f5e8cf1477976ad7717461 Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 15:15:09 +0200 Subject: [PATCH 10/11] Updated path for docs deployment workflow --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index e48aa69a..e5cbd4ac 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -33,4 +33,4 @@ jobs: if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: doc/build/html + publish_dir: doc/_build/html From fb38beda7e935417070d0ce47d070bbf49c3b458 Mon Sep 17 00:00:00 2001 From: Michiel Tukker Date: Thu, 25 Jun 2026 15:18:09 +0200 Subject: [PATCH 11/11] Run workflow on every push (not just PR updates) --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index e5cbd4ac..0febd684 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,6 +1,6 @@ name: "Sphinx: Render docs" -on: pull_request +on: [push] jobs: build: