Documentation tests #2186

	name: test-docs
	run-name: Documentation tests

	on:
	pull_request:
	push:
	branches: [main]

	permissions:
	contents: read

	env:
	HATCH_ENV_TYPE_VIRTUAL_PATH: ${{ github.workspace }}/.hatch_envs

	jobs:
	doc-test:
	name: Sphinx Documentation Tests
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4
	with:
	persist-credentials: false

	- uses: actions/setup-python@v5
	with:
	python-version: '3.x'
	cache: 'pip'

	- name: Cache Hatch environments
	uses: actions/cache@v4
	with:
	path: \|
	${{ github.workspace }}/.hatch_envs
	key: hatch-envs-${{ hashFiles('pyproject.toml') }}

	- name: Install hatch
	run: pip install hatch

	- name: Run sphinx html builder
	# -W = warnings as error
	run: hatch run docs:html -W

	- name: Run sphinx linkcheck
	run: hatch run docs:linkcheck

Provide feedback