From e670605700731383d4a5b93223c6f92972c4afd2 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sat, 13 Nov 2021 17:15:31 +0000 Subject: [PATCH] Fix building docs in CI Older versions of Sphinx don't work with whatever the default version of Python is on GitHub Actions, and never versions of Sphinx need a newer version of Python. Also update the RTD theme and Breathe while I'm at it. --- .github/workflows/ci.yml | 8 ++++++++ .github/workflows/release.yml | 8 ++++++++ .readthedocs.yml | 2 +- docs/requirements.txt | 6 +++--- 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6ba4b1dc..aafc8570 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -123,6 +123,10 @@ jobs: ./libloot_internals_tests ./libloot_tests + - uses: actions/setup-python@v2 + with: + python-version: '3.10' + - name: Install packages for building docs shell: bash run: | @@ -201,6 +205,10 @@ jobs: .\libloot_internals_tests.exe .\libloot_tests.exe + - uses: actions/setup-python@v2 + with: + python-version: '3.10' + - name: Install packages for building docs run: | nuget install doxygen -Version 1.8.14 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a83bdb57..34e91b5f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -99,6 +99,10 @@ jobs: ./libloot_internals_tests ./libloot_tests + - uses: actions/setup-python@v2 + with: + python-version: '3.10' + - name: Install packages for building docs shell: bash run: | @@ -174,6 +178,10 @@ jobs: cmake .. -G "Visual Studio 15 2017" -A ${{ matrix.platform }} -DBOOST_ROOT="boost_1_72_0" -DCPACK_PACKAGE_VERSION="${{ steps.get-libloot-version.outputs.version }}" cmake --build . --config ${{ env.MSVC_CONFIG }} + - uses: actions/setup-python@v2 + with: + python-version: '3.10' + - name: Install packages for building docs run: | nuget install doxygen -Version 1.8.14 diff --git a/.readthedocs.yml b/.readthedocs.yml index bc50e910..72b722d3 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,6 +6,6 @@ sphinx: formats: all python: - version: 3.7 + version: 3.10 install: - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt index a9fe7ebf..4cbea6d0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ -sphinx==2.0.1 -sphinx_rtd_theme==0.4.3 -breathe==4.13.0 +sphinx==4.2.0 +sphinx_rtd_theme==1.0.0 +breathe==4.31.0