Add Sphinx documentation and prepare v1.0.0 release #11

	name: CI

	on:
	push:
	branches: [main]
	pull_request:

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

	jobs:
	test:
	name: test (${{ matrix.os }}, py${{ matrix.python }})
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest, windows-latest]
	python: ["3.11", "3.12"]
	steps:
	- uses: actions/checkout@v4
	- uses: astral-sh/setup-uv@v5
	- name: Create environment
	run: uv venv --python ${{ matrix.python }}
	- name: Install
	run: uv pip install -e ".[dev]"
	- name: Test (GPU tests auto-skip without a device)
	run: uv run pytest -q

	lint:
	name: lint + types
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: astral-sh/setup-uv@v5
	- name: Create environment
	run: uv venv --python 3.12
	- name: Install
	run: uv pip install -e ".[dev]"
	- name: Ruff
	run: uv run ruff check src tests
	- name: Mypy
	run: uv run mypy

	docs:
	name: docs build
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: astral-sh/setup-uv@v5
	- name: Create environment
	run: uv venv --python 3.12
	- name: Install
	run: uv pip install -e ".[docs]"
	# -W turns broken cross-references / malformed docstrings into build failures.
	- name: Build (warnings are errors)
	run: uv run sphinx-build -b html -W --keep-going docs docs/_build/html

Navigation Menu