Skip to content

Commit

Permalink
Fail the build on any Sphinx warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
Jay Chia committed Sep 7, 2024
1 parent cfb2024 commit 2b3a696
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -857,9 +857,11 @@ jobs:
uv pip install -r requirements-dev.txt
uv pip install ./dist/*.whl
- name: Build docs
# NOTE: This will break on any Sphinx warnings
# See: https://stackoverflow.com/questions/38048945/how-to-turn-warnings-into-errors-when-building-sphinx-documentation-with-setupto
run: |
cd docs/
make html
make html SPHINXOPTS="-W --keep-going -n"
- name: Upload docs
uses: actions/upload-artifact@v4
with:
Expand Down

0 comments on commit 2b3a696

Please sign in to comment.