CI #171

	name: CI

	# Controls when the workflow will run
	on:
	# Triggers the workflow on push or pull request events but only for the "develop" branch
	push:
	branches: [ "develop" ]
	pull_request:
	branches: [ "develop" ]

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

	# A workflow run is made up of one or more jobs that can run sequentially or in parallel
	jobs:
	# This workflow contains a single job called "build"
	build-sphinx:
	# The type of runner that the job will run on
	runs-on: ubuntu-latest

	# Steps represent a sequence of tasks that will be executed as part of the job
	steps:
	- name: Restore lychee (linkcheck) cache
	uses: actions/cache@v3
	with:
	path: .lycheecache
	key: cache-lychee-${{ github.sha }}
	restore-keys: cache-lychee-

	# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
	- uses: actions/checkout@v3

	# Install newer python and pip
	- uses: actions/setup-python@v4
	with:
	python-version: '3.11'


	# install deps
	- name: Install dependencies
	run: pip install -r requirements.txt

	# build docs. "-n" for nitpick link checking
	- name: Run sphinx build. No warnings allowed but keep going.
	run: sphinx-build -M html ./docs build -W --keep-going -n

	# link check of html
	- name: Run lychee
	uses: lycheeverse/[email protected]
	with:
	fail: true
	args: --cache --max-cache-age 1d './*/.html'

	# upload html
	- uses: actions/upload-artifact@v3
	with:
	name: html
	path: build/

Provide feedback