Add a ci check for the generated docs #226

	name: Run code checks with different build tools

	on:
	- push
	- pull_request

	jobs:

	python-build:

	runs-on: ubuntu-latest
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.8", "3.12"]

	steps:
	- uses: actions/checkout@v4

	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}

	- name: Install the build module
	run: pip install build

	- name: Build the alot package
	run: python3 -m build


	nix-flake:
	runs-on: ubuntu-latest
	strategy:
	fail-fast: false
	matrix:
	derivation:
	- default
	- alot.doc
	- alot.man

	steps:
	- name: Install Nix
	uses: cachix/install-nix-action@v22

	- uses: actions/checkout@v4

	- name: Build the ${{ matrix.derivation }} derivation
	run: 'nix build --print-build-logs .\#${{ matrix.derivation }}'


	generated-docs:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"

	- name: Remove and mock problematic dependencies
	run: \|
	sed -i '/gpg/d;/notmuch2/d' pyproject.toml
	touch gpg.py
	echo NullPointerError = NotmuchError = None > notmuch2.py
	pip install .
	git checkout pyproject.toml

	- name: Regenerate all generated docs
	# We run "true" instead of "sphinx-build" to speed things up as we are
	# only interested in the regeneration of the docs.
	run: make -C docs cleanall html SPHINXBUILD=true

	- name: Compare the generated docs with the version committed to git
	run: git diff --exit-code

Provide feedback