From 28d76073b0ffa2ff74e216eb32ac8e95e913ec0e Mon Sep 17 00:00:00 2001
From: Michal Sniatala <michal@sniatala.pl>
Date: Sun, 20 Oct 2024 08:42:42 +0200
Subject: [PATCH] fix: pin python version for sphinx (#9224)

* dev: pin python version for sphinx

* dev: pin python for deploy workflow
---
 .github/workflows/deploy-distributables.yml   | 10 +++++++---
 .github/workflows/deploy-userguide-latest.yml | 17 +++++++++++++----
 .github/workflows/test-userguide.yml          | 17 +++++++++++++----
 3 files changed, 33 insertions(+), 11 deletions(-)

diff --git a/.github/workflows/deploy-distributables.yml b/.github/workflows/deploy-distributables.yml
index f28a62544fa5..7c0b4e4dd1ce 100644
--- a/.github/workflows/deploy-distributables.yml
+++ b/.github/workflows/deploy-distributables.yml
@@ -159,11 +159,15 @@ jobs:
           token: ${{ secrets.ACCESS_TOKEN }}
           path: userguide
 
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
       - name: Install Sphinx
         run: |
-          sudo apt install python3-sphinx
-          sudo pip3 install sphinxcontrib-phpdomain
-          sudo pip3 install sphinx_rtd_theme
+          python -m pip install --upgrade pip
+          pip install -r ./source/user_guide_src/requirements.txt
 
       - name: Chmod
         run: chmod +x ./source/.github/scripts/deploy-userguide
diff --git a/.github/workflows/deploy-userguide-latest.yml b/.github/workflows/deploy-userguide-latest.yml
index c131c80cd735..9188672f907a 100644
--- a/.github/workflows/deploy-userguide-latest.yml
+++ b/.github/workflows/deploy-userguide-latest.yml
@@ -33,11 +33,20 @@ jobs:
           php-version: '8.1'
           coverage: none
 
-      # Build the latest User Guide
-      - name: Build with Sphinx
-        uses: ammaraskar/sphinx-action@0.4
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
-          docs-folder: user_guide_src/
+          python-version: '3.12'
+
+      - name: Install Sphinx
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r user_guide_src/requirements.txt
+
+      # Build the latest User Guide
+      - name: Build Docs with Sphinx
+        run: make html
+        working-directory: user_guide_src
 
       - name: Add "Edit this page" links
         run: |
diff --git a/.github/workflows/test-userguide.yml b/.github/workflows/test-userguide.yml
index b127d77dd344..f1e0d0bd60e6 100644
--- a/.github/workflows/test-userguide.yml
+++ b/.github/workflows/test-userguide.yml
@@ -26,10 +26,19 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Sphinx
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r user_guide_src/requirements.txt
+
       - name: Detect usage of tabs in RST files
         run: php utils/check_tabs_in_rst.php
 
-      - uses: ammaraskar/sphinx-action@0.4
-        with:
-          docs-folder: user_guide_src
-          build-command: 'make html SPHINXOPTS="-W --keep-going -w /tmp/sphinx-log"'
+      - name: Build Docs with Sphinx
+        run: make html SPHINXOPTS="-W --keep-going -w /tmp/sphinx-log"
+        working-directory: user_guide_src