ci: fail Sphinx doc builds on warnings and deploy on successful merge to main #19

	name: Deploy Sphinx documentation to Pages

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]

	jobs:
	build:
	runs-on: ubuntu-latest
	permissions:
	contents: read
	steps:
	- name: Checkout repository
	uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: 3.11

	- name: Install dependencies
	run: \|
	python -m pip install -U pip
	pip install -r docs/requirements.txt

	- name: Build docs with Sphinx (fail on warnings)
	run: \|
	sphinx-build -W -b html docs/ build

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

	deploy:
	needs: build
	runs-on: ubuntu-latest
	if: github.ref == 'refs/heads/main'
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback