-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
automation: add workflow to fail on warnings during docs build
- Loading branch information
1 parent
610fa6e
commit 2c7cddb
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# This is a GitHub workflow defining a set of jobs with a set of steps. | ||
# ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions | ||
# | ||
name: Test docs | ||
|
||
on: | ||
pull_request: | ||
push: | ||
branches-ignore: | ||
- "dependabot/**" | ||
- "pre-commit-ci-update-config" | ||
workflow_dispatch: | ||
|
||
jobs: | ||
test-docs: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.11" | ||
|
||
- name: Install deps | ||
run: pip install -r requirements.txt | ||
|
||
# linkcheck is done separately from this in doc-links.yml, scheduled to | ||
# run every day and open/update an issue | ||
- name: make dirhtml | ||
run: | | ||
make dirhtml SPHINXOPTS='--color -W --keep-going' |