Merge pull request #41 from hhoppe:main #8

	name: website

	# Adapted from https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml

	# Build the documentation whenever there are new commits on main.
	on:
	push:
	branches:
	- main

	# Security: restrict permissions for CI jobs.
	permissions:
	contents: read

	jobs:
	# Build the documentation and upload the static HTML files as an artifact.
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions/setup-python@v4
	with:
	python-version: '3.x'

	# Install all dependencies (including pdoc).
	- run: pip install .
	- run: pip install pdoc

	# Build the documentation into pdoc_files/html/.
	- run: python pdoc_files/make.py

	- uses: actions/upload-pages-artifact@v1
	with:
	path: pdoc_files/html/

	# Deploy the artifact to GitHub pages.
	# This is a separate job so that only actions/deploy-pages has the necessary permissions.
	deploy:
	needs: build
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v1

Provide feedback