docs

chore: final tweaks before release #47

	name: docs

	on:
	push:
	branches:
	- main
	pull_request:
	workflow_dispatch:

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

	permissions:
	contents: read

	jobs:
	build:
	name: Build docs
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v5
	with:
	fetch-depth: 0

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

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade uv
	uv pip install --system ".[docs]"

	- name: Build documentation
	run: \|
	cd docs
	make html -j 4

	- name: Fix permissions if needed
	run: \|
	chmod -c -R +rX "docs/_build/html/" \| while read line; do
	echo "::warning title=Invalid file permissions automatically fixed::$line"
	done

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v4
	with:
	path: "docs/_build/html"

	deploy:
	name: Deploy docs to GitHub Pages
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	needs: build
	# Set permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	runs-on: ubuntu-latest

	steps:
	- name: Setup Pages
	uses: actions/configure-pages@v5

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

Provide feedback