Skip to content

Commit

Permalink
fix: pin python version for sphinx (#9224)
Browse files Browse the repository at this point in the history
* dev: pin python version for sphinx

* dev: pin python for deploy workflow
  • Loading branch information
michalsn authored Oct 20, 2024
1 parent c7ab0d1 commit 28d7607
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 11 deletions.
10 changes: 7 additions & 3 deletions .github/workflows/deploy-distributables.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 13 additions & 4 deletions .github/workflows/deploy-userguide-latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,20 @@ jobs:
php-version: '8.1'
coverage: none

# Build the latest User Guide
- name: Build with Sphinx
uses: ammaraskar/[email protected]
- 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: |
Expand Down
17 changes: 13 additions & 4 deletions .github/workflows/test-userguide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
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

0 comments on commit 28d7607

Please sign in to comment.