Skip to content

automation: add workflow to fail on warnings during docs build #2

automation: add workflow to fail on warnings during docs build

automation: add workflow to fail on warnings during docs build #2

Workflow file for this run

# 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:
paths:
- "docs/**"
- "**/test-docs.yaml"
push:
paths:
- "docs/**"
- "**/test-docs.yaml"
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 docs/requirements.txt
- name: make linkcheck
run: |
cd docs
make dirhtml SPHINXOPTS='--color -W --keep-going'