From f29f6cd0f61816db63fe9c6c725765fde80b66ce Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Mon, 12 May 2025 07:52:07 +0100 Subject: [PATCH] Update Breathe to v4.36.0 The new version of Breathe requires Doxygen v1.9.2+, so also upgrade Doxygen in the Windows CI builds. --- .github/workflows/ci.yml | 7 +++++-- .github/workflows/release.yml | 7 +++++-- README.md | 2 +- docs/requirements.txt | 2 +- 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index af1412ab..fad8b203 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -207,8 +207,11 @@ jobs: - name: Install packages for building docs run: | - nuget install doxygen -Version 1.8.14 - echo "${{ github.workspace }}\Doxygen.1.8.14\tools" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append + curl -sSfLO https://github.com/doxygen/doxygen/releases/download/Release_1_13_2/doxygen-1.13.2.windows.x64.bin.zip + Expand-Archive doxygen-1.13.2.windows.x64.bin.zip + + echo "${{ github.workspace }}\doxygen-1.13.2.windows.x64.bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append + python -m pip install -r docs/requirements.txt - name: Build docs diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index edf891ca..6adc046c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -99,8 +99,11 @@ jobs: - name: Install packages for building docs run: | - nuget install doxygen -Version 1.8.14 - echo "${{ github.workspace }}\Doxygen.1.8.14\tools" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append + curl -sSfLO https://github.com/doxygen/doxygen/releases/download/Release_1_13_2/doxygen-1.13.2.windows.x64.bin.zip + Expand-Archive doxygen-1.13.2.windows.x64.bin.zip + + echo "${{ github.workspace }}\doxygen-1.13.2.windows.x64.bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append + python -m pip install -r docs/requirements.txt - name: Build docs diff --git a/README.md b/README.md index d3446dcb..6b7fd2d8 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ You may also need to set `CMAKE_PREFIX_PATH` if CMake cannot find Boost. ## Building The Documentation -The documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/), [Breathe](https://breathe.readthedocs.io/en/latest/) and [Sphinx](http://www.sphinx-doc.org/en/stable/). Install Doxygen and Python and make sure they're accessible from your `PATH`, then run: +The documentation is built using [Doxygen](https://www.doxygen.nl/), [Breathe](https://www.breathe-doc.org/) and [Sphinx](http://www.sphinx-doc.org/en/stable/). Install Doxygen and Python and make sure they're accessible from your `PATH`, then run: ``` py -m venv .venv diff --git a/docs/requirements.txt b/docs/requirements.txt index 3adecce7..e2355aac 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ sphinx==7.3.7 sphinx_rtd_theme==3.0.2 -breathe==4.35.0 +breathe==4.36.0