Update docs #196

	name: Deploy Sphinx Docs

	on:
	push:
	branches:
	- main
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: "pages"
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.10'
	- name: Install dependencies
	run: \|
	pip install .[dev]
	- name: Inject future annotations for Sphinx build
	run: \|
	# Find all python files in the 'tropt' directory and prepend the future import
	# [See issue: https://github.com/sphinx-doc/sphinx/issues/11211#issuecomment-3447848093]
	find tropt -name "*.py" ! -name "common.py" -exec sed -i '1s/^/from __future__ import annotations\n/' {} +
	- name: Build Sphinx Docs
	run: \|
	sphinx-build -b html docs docs/_build/html
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: docs/_build/html

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Navigation Menu