Skip to content

Commit db86eb1

Browse files
committed
ci(docs): update Sphinx workflow to use sphinx-notes/pages action
Replaced `uncch-rdmc/sphinx-action` with `sphinx-notes/pages` for better compatibility and flexibility (Python & Sphinx versions!!!). Added dynamic Sphinx version lookup and updated paths and options to align with the new action requirements.
1 parent bb0262a commit db86eb1

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

.github/workflows/guides_build_sphinx.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v4
14-
- uses: uncch-rdmc/sphinx-action@master
14+
- id: lookup
15+
run: |
16+
echo "sphinx_version=$(grep Sphinx== ./doc/sphinx-guides/requirements.txt | tr -s "=" | cut -f 2 -d=)" | tee -a "${GITHUB_OUTPUT}"
17+
- run: |
18+
sudo apt-get update -q
19+
sudo apt-get install -qqy --no-install-recommends graphviz
20+
- uses: sphinx-notes/pages@v3
1521
with:
16-
docs-folder: "doc/sphinx-guides/"
22+
documentation_path: ./doc/sphinx-guides/source
23+
requirements_path: ./doc/sphinx-guides/requirements.txt
24+
sphinx_version: ${{ steps.lookup.outputs.sphinx_version }}
25+
sphinx_build_options: "-W"
26+
cache: false
27+
publish: false
28+

0 commit comments

Comments
 (0)