Skip to content

Commit

Permalink
Point to requirements file when building docs
Browse files Browse the repository at this point in the history
This applies both to the RTD builds and to the GHA builds. The latter
has been re-designed to not use the sphinx-action action anymore, since
it's unmaintained, and was based on python 3.8, for which there are no
recent Sphinx versions published.

Signed-off-by: Rodrigo Tobar <[email protected]>
  • Loading branch information
rtobar committed Jul 4, 2024
1 parent 81d2a8d commit f47f426
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.12
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "doc"
pre-build-command: 'pip install -U sphinx_rtd_theme docutils'
- name: Install dependencies
run: pip install -r doc/requirements.txt
- name: Build documentation
env:
SPHINXOPTS: -W --keep-going
run: make html -C doc
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ submodules:
sphinx:
configuration: doc/conf.py
fail_on_warning: true

python:
install:
- requirements: doc/requirements.txt

0 comments on commit f47f426

Please sign in to comment.