Docs

fail evaluation when source checkpoint is missing #94

	name: Docs

	on:
	pull_request:
	paths:
	- .github/workflows/docs.yml
	- docs/**
	- src/**
	- pyproject.toml
	- uv.lock
	push:
	branches:
	- main
	paths:
	- .github/workflows/docs.yml
	- docs/**
	- src/**
	- pyproject.toml
	- uv.lock
	workflow_dispatch:

	permissions:
	contents: read

	concurrency:
	group: pages-${{ github.ref }}
	cancel-in-progress: false

	jobs:
	build:
	name: build docs
	runs-on: ubuntu-latest
	steps:
	- name: Check out repository
	uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

	- name: Set up Python
	uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
	with:
	python-version: "3.12"

	- name: Set up uv
	uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
	with:
	enable-cache: true

	- name: Install dependencies
	run: \|
	sudo apt update && sudo apt install -y graphviz
	uv sync --frozen --group docs

	- name: Build HTML
	run: >
	uv run sphinx-build
	-W
	-b html
	docs
	docs/_build/html

	- name: Upload Pages artifact
	uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
	with:
	path: docs/_build/html

	deploy:
	name: deploy docs
	needs: build
	if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5

Provide feedback