supervised fit #31

	name: Documentation

	on:
	push:
	branches: [main]
	paths:
	- "docs/**"
	- "mkdocs.yml"
	- "README.md"
	- ".github/workflows/docs.yml"
	pull_request:
	branches: [main]
	paths:
	- "docs/**"
	- "mkdocs.yml"
	workflow_dispatch:

	# Required permissions for the deploy-pages action
	permissions:
	contents: read
	pages: write
	id-token: write

	# Avoid concurrent deploys
	concurrency:
	group: pages
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0 # full history for `git revision-date` mkdocs plugin if enabled

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"
	cache: pip
	cache-dependency-path: pyproject.toml

	- name: Install docs deps
	run: \|
	python -m pip install --upgrade pip
	pip install -e ".[docs]"

	- name: Build site
	run: mkdocs build --strict

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: site/

	deploy:
	# Only deploy on push to main (not on PRs)
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	needs: build
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Navigation Menu