update docs #118

	name: CI

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

	jobs:
	pre-commit:
	name: Format + lint code
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0
	- uses: actions/setup-python@v5
	with:
	python-version: "3.x"
	- uses: pre-commit/[email protected]
	with:
	extra_args: --hook-stage manual --all-files

	checks:
	name:
	Run tests for Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
	runs-on: ${{ matrix.runs-on }}
	needs: [pre-commit]
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.10", "3.11"]
	runs-on: [ubuntu-latest] # can be extended to other OSes, e.g. macOS/Windows if needed

	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0

	- uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	allow-prereleases: true

	- name: Install package
	run: python -m pip install .[test]

	- name: Test package
	run: >-
	python -m pytest -ra --cov --cov-report=xml --cov-report=term
	--durations=20

	# - name: Upload coverage report
	# uses: codecov/[email protected]

	# - name: Test examples
	# run: >-
	# for f in examples/*.py; do echo "run $f" && python "$f"; done

Provide feedback