Docs

docs(badge): add download badge #73

	name: Docs

	on:
	push:
	branches:
	- master
	pull_request:

	jobs:
	build:
	name: Build docs (python-${{ matrix.os }})
	strategy:
	matrix:
	os:
	- ubuntu-latest
	fail-fast: false
	runs-on: ${{ matrix.os }}
	env:
	UV_HTTP_TIMEOUT: 900 # max 15min to install deps
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0

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

	- name: "Set up Python"
	uses: actions/setup-python@v5
	with:
	python-version-file: "pyproject.toml"

	- name: Install the project
	run: uv sync --extra docs

	- name: Build docs
	run: uv run mkdocs build

	- name: Minimize uv cache
	run: uv cache prune --ci

	deploy:
	name: Deploy docs
	needs: build
	if: github.event_name == 'push' && github.ref == 'refs/heads/master'
	runs-on: ubuntu-latest
	env:
	UV_HTTP_TIMEOUT: 900 # max 15min to install deps
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0

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

	- name: "Set up Python"
	uses: actions/setup-python@v5
	with:
	python-version-file: "pyproject.toml"

	- name: Install the project
	run: uv sync --extra docs

	- name: Deploy docs
	run: uv run mkdocs gh-deploy --force

	- name: Minimize uv cache
	run: uv cache prune --ci

Provide feedback