Merge remote-tracking branch 'origin/main' #17

	name: Build & Deploy Documentation

	# Touching this file or the docs sources triggers a fresh Pages deployment.

	on:
	push:
	branches:
	- main
	paths:
	- 'README.md'
	- 'concepts.md'
	- 'notes.md'
	- 'user_manual.md'
	- 'docs/**'
	- '.github/workflows/deploy-docs.yml'
	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
	with:
	# Set this to false to ignore broken submodule links during doc builds
	submodules: false
	fetch-depth: 0

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: '3.10'

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install sphinx sphinx-rtd-theme rinohtype

	- name: Build HTML documentation
	run: \|
	sphinx-build -W --keep-going -b html docs/source 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