Repository navigation

docs: add Doxygen API reference to the versioned documentation site #40

	name: Documentation build

	on:
	pull_request:
	push:
	branches:
	- main
	paths:
	- docs/**
	- boards.txt
	- mkdocs.yml
	- requirements-docs.txt
	- doxygen/**
	- cores/**
	- libraries/**
	- variants/**
	- system/**
	- "!system/Drivers/**"
	- "!system/Middlewares/**"
	- .github/workflows/docs-check.yml

	permissions:
	contents: read

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v7
	with:
	fetch-depth: 0
	- uses: actions/setup-python@v7
	with:
	python-version: "3.x"
	- run: python -m pip install -r requirements-docs.txt
	- name: Install Doxygen
	run: sudo apt-get update && sudo apt-get install --yes doxygen
	- name: Build Doxygen API reference
	run: \|
	STM32_CORE_VERSION=$(sed -n 's/^version=//p' platform.txt)
	export STM32_CORE_VERSION
	doxygen doxygen/Doxyfile
	test -f build/doxygen/index.html
	- run: mkdocs build --strict
	- name: Check the Doxygen API reference is part of the site
	run: grep -q 'name="generator" content="Doxygen' site/doxygen/index.html
	- name: Check generated supported boards page is committed
	run: git diff --exit-code -- docs/supported-boards/index.md \|\| { echo "::error::Run 'python docs/hooks/supported_boards.py' and commit docs/supported-boards/index.md"; exit 1; }