Build documentation #334

	name: Build documentation

	on:
	schedule:
	# Once a month is enough
	- cron: '0 1 15 * *'
	pull_request:
	workflow_dispatch:

	jobs:
	check-links:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v5
	- uses: actions/setup-python@v5
	with:
	python-version: '3.13'
	cache: 'pip'

	- name: Build the documentation
	run: \|
	pip install -r requirements.txt
	sphinx-build docs docs/_build/html

	# ref: https://github.com/lycheeverse/lychee-action
	# ref: https://github.com/lycheeverse/lychee#commandline-parameters
	- name: Link Checker
	uses: lycheeverse/lychee-action@v2.6.1
	env:
	GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
	with:
	fail: true
	# github.com link below: This is a known fail
	args: >
	docs/_build/*/.html
	--insecure
	--max-retries 10
	--exclude-link-local
	--exclude mailto
	--exclude https://github.com/executablebooks/meta/edit/main/docs/contributing.md
	jobSummary: true

Provide feedback