Docs

Add a documentation site, and reduce the README to a landing page (#38) #2

	name: Docs

	on:
	push:
	branches:
	- master
	# build (but do not deploy) on pull requests, so that a broken link or a
	# page missing from the nav fails before it reaches master
	pull_request:
	branches:
	- master

	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@v7
	- name: Install uv
	uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
	with:
	enable-cache: true
	cache-dependency-glob: "pyproject.toml"
	- name: Install docs dependencies
	run: uv sync --only-group docs
	- name: Build docs
	run: uv run --no-sync mkdocs build --strict
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v5
	with:
	path: site

	deploy:
	if: github.event_name == 'push'
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v5

Navigation Menu