documentation workflow #184

	name: documentation_workflow
	run-name: documentation workflow

	# Allow one concurrent deployment
	concurrency:
	group: "pages"
	cancel-in-progress: true

	on:
	push:
	branches:
	- main
	paths:
	- docs/*/
	- mkdocs.yml

	pull_request:
	paths:
	- docs/*/
	- mkdocs.yml

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@v3

	- uses: actions/setup-python@v4
	with:
	python-version: 3.x

	- uses: actions/cache@v3
	with:
	key: ${{ github.ref }}
	path: .cache

	- name: Setup Pages
	id: pages
	uses: actions/configure-pages@v2

	- name: Install Material for MkDocs dependencies
	shell: bash
	run: \|
	sudo apt install --yes \
	libcairo2-dev \
	libfreetype6-dev \
	libffi-dev \
	libjpeg-dev \
	libpng-dev \
	libz-dev
	pip install \
	cairosvg \
	mkdocs-material \
	mkdocs-minify-plugin \
	mkdocs-git-revision-date-localized-plugin \
	mkdocs-glightbox \
	pillow

	- name: Build Material for MkDocs
	shell: bash
	run: \|
	mkdocs build --site-dir public

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v1
	with:
	path: ./public

	deploy:
	needs: build
	runs-on: ubuntu-latest
	# Only run on main
	if: success() && github.ref == 'refs/heads/main'
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v1

Provide feedback