Skip to content

Commit fd9c337

Browse files
committed
Update docs workflow with additional steps to install requirements for sphinx (rtd theme).
1 parent 5b12ca5 commit fd9c337

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

.github/workflows/docs.yml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,33 @@ on:
88

99
jobs:
1010
build:
11-
runs-on: ubuntu-latest
11+
runs-on: ubuntu-24.04
1212
permissions:
1313
contents: write
1414
steps:
1515
- uses: actions/checkout@v4
1616
with:
1717
persist-credentials: false
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: '3.12'
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -r docs/requirements.txt
28+
1829
- name: Build HTML
1930
uses: ammaraskar/sphinx-action@master
31+
2032
- name: Upload artifacts
2133
uses: actions/upload-artifact@v4
2234
with:
2335
name: html-docs
2436
path: docs/build/html/
37+
2538
- name: Deploy
2639
uses: peaceiris/actions-gh-pages@v3
2740
if: github.ref == 'refs/heads/master'

docs/requirements.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
furo==2021.11.16
1+
furo==2021.11.16
2+
Sphinx==7.4.7
3+
sphinx-rtd-theme==3.0.2

0 commit comments

Comments
 (0)