Docs

feat(config)!: registry-key adapter resolution, drop unsafe _target_ (#301) #1143

	name: Docs

	on:
	pull_request:
	push:
	branches:
	- main
	workflow_dispatch:
	inputs:
	deploy:
	description: "Deploy main to GitHub Pages (bypasses release coupling; site may not match PyPI)"
	required: true
	default: false
	type: boolean

	permissions:
	contents: read

	concurrency:
	group: "docs-${{ github.ref }}"
	cancel-in-progress: true

	jobs:
	build:
	name: Build documentation
	runs-on: ubuntu-latest
	permissions:
	contents: read
	pages: write
	id-token: write

	steps:
	- name: Checkout code
	uses: actions/checkout@v7

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

	- name: Install uv
	uses: astral-sh/setup-uv@v7
	with:
	enable-cache: true
	cache-dependency-glob: "uv.lock"

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

	- name: Check LLM-friendly frontmatter + code-fence normalisation
	run: uv run python scripts/llmify_docs.py --check

	- name: Build documentation
	run: uv run sphinx-build -b html -n -W --keep-going docs docs/_build/html

	- name: Set up Pages
	if: github.event_name == 'workflow_dispatch' && inputs.deploy
	uses: actions/configure-pages@v6

	- name: Upload Pages artifact
	if: github.event_name == 'workflow_dispatch' && inputs.deploy
	uses: actions/upload-pages-artifact@v5
	with:
	path: docs/_build/html

	deploy:
	name: Deploy documentation
	if: github.event_name == 'workflow_dispatch' && inputs.deploy
	needs: build
	runs-on: ubuntu-latest
	permissions:
	contents: read
	pages: write
	id-token: write

	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v5

Navigation Menu