docs

Release/v1.5.0 #2

	name: docs

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

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

	permissions:
	contents: read

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	submodules: recursive

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"
	cache: pip

	- name: Install package with docs extras
	run: \|
	python -m pip install --upgrade pip
	pip install -e ".[docs]"

	- name: Build documentation
	run: sphinx-build -b html -W docs docs/_build/html

	- name: Upload Pages artifact
	if: github.event_name == 'push'
	uses: actions/upload-pages-artifact@v3
	with:
	path: docs/_build/html

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

Navigation Menu