Skip to content

Commit

Permalink
build: Ignore Sphinx errors on master builds
Browse files Browse the repository at this point in the history
Use `-W` to Sphinx only when building on pull requests, but not master.
This allows to easily catch new warnings during PRs, while still
allowing to ignore them for a while and keep up to date documentation
built for master in most cases.
  • Loading branch information
Wuestengecko committed Jul 2, 2024
1 parent 6aa4022 commit fe76ae2
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ jobs:
- name: Auto-generate APIDOC sources
run: make -C docs apidoc
- name: Create docs
env:
SPHINXOPTS: ${{ github.ref != 'refs/heads/master' && "-W" || "" }}
run: make -C docs html
- name: Upload built docs as artifact
uses: actions/upload-artifact@v4
Expand Down

0 comments on commit fe76ae2

Please sign in to comment.