Skip to content

Build documentation in CI and fail on warnings #1

Build documentation in CI and fail on warnings

Build documentation in CI and fail on warnings #1

Workflow file for this run

name: Docs

Check warning on line 1 in .github/workflows/docs.yml

View workflow run for this annotation

GitHub Actions / Docs

Workflow execution policy warning (evaluate mode)

Event 'pull_request' is not allowed to trigger Actions workflows. Workflow file: '.github/workflows/docs.yml'.
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