name: Documentation
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Sphinx HTML
run: |
pip install -r docs/requirements.txt
sphinx-build -b html docs/source docs/_build/html
- name: Install lychee
uses: taiki-e/install-action@v2
with:
tool: lychee@0.24.2
- name: Link check (lychee)
run: lychee --config lychee.toml 'docs/_build/html/**/*.html'