doc: clean up documenatation builds and update readme #16

	name: Build docs

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

	permissions:
	contents: write

	jobs:
	build-docs:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: '3.11'
	- name: Install uv
	uses: astral-sh/setup-uv@v6
	- name: Install the project
	run: uv sync --locked --all-extras --dev
	- name: Install sphinx dependencies
	run: pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme myst-parser
	- name: Build HTML
	run: sphinx-build docs/source _build
	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v3
	if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
	with:
	publish_branch: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: _build/
	force_orphan: true

Provide feedback