Repository navigation
Build documentation in CI and fail on warnings #1
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs | ||
| on: [push, pull_request, workflow_dispatch] | ||
| permissions: | ||
| contents: read | ||
| jobs: | ||
| docs: | ||
| name: Build documentation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0 | ||
| with: | ||
| python-version: "3.11" | ||
| - name: Install dependencies | ||
| run: python -m pip install sphinx | ||
| - name: Build documentation | ||
| run: make -C doc clean html SPHINXOPTS=-W | ||