Deploy Documentation #308

	name: Deploy Documentation

	on:
	push:
	branches:
	- main
	paths:
	- "docs/**"
	- "mkdocs.yml"
	# Rebuilds periodically so the GitHub repo widget (version, stars, forks)
	# stays current; MkDocs Material fetches these stats at build time.
	schedule:
	- cron: "0 /6 * *"
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: pages
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

	- uses: astral-sh/setup-uv@f98e06938123ccabd21905ea5d0069192241f9f1 # v8.3.1
	with:
	enable-cache: true
	cache-dependency-glob: "uv.lock"

	- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
	with:
	python-version: "3.12"

	- name: Install dependencies
	run: uv sync --group docs

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

	- uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
	with:
	path: site

	deploy:
	needs: build
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

Navigation Menu