Fill out some basic documentation #74

	name: Documentation

	on:
	push:
	branches:
	- main
	- v0.*.x
	tags:
	- v*
	pull_request:
	workflow_dispatch:

	permissions: {} # disables all GitHub permissions for the workflow

	jobs:
	documentation:
	name: Doc Build - py${{ matrix.python }} on ${{ matrix.os }}
	runs-on: ${{ matrix.os }}

	strategy:
	fail-fast: false
	matrix:
	python: ['3.8', '3.10', '3.12', '3.13']
	os: [ubuntu-latest]

	steps:
	- name: Checkout code
	uses: actions/checkout@v3
	with:
	fetch-depth: 1
	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: ${{ matrix.python }}
	cache: 'pip'
	- name: Install dependencies
	run: \|
	python -m pip install --progress-bar off --upgrade pip
	python -m pip install --progress-bar off -r requirements/docs.txt
	sudo apt-get install graphviz pandoc
	- name: Build Docs
	run: \|
	sphinx-build ./docs ./docs/_build -n --keep-going -b html -q

	sphinx_limits:
	name: Doc Build on ${{ matrix.sphinx }}
	runs-on: ${{ matrix.os }}

	strategy:
	fail-fast: false

	matrix:
	include:
	- python: '3.12'
	os: ubuntu-latest
	sphinx: 'sphinx<7.4'

	- python: '3.12'
	os: ubuntu-latest
	sphinx: 'sphinx<8.2'

	steps:
	- name: Checkout code
	uses: actions/checkout@v3
	with:
	fetch-depth: 1
	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: ${{ matrix.python }}
	cache: 'pip'
	- name: Install dependencies
	run: \|
	python -m pip install --progress-bar off --upgrade pip
	python -m pip install --progress-bar off -r requirements/docs.txt "${{ matrix.sphinx }}"
	sudo apt-get install graphviz pandoc
	- name: Build Docs
	run: \|
	sphinx-build ./docs ./docs/_build -n --keep-going -W -b html -q

Provide feedback