Docs

chore(release): prepare v1.5.5 #62

	name: Docs

	on:
	push:
	branches:
	- main
	- reports
	paths:
	- ".github/workflows/docs.yml"
	- "docs/**"
	- "mkdocs.yml"
	- "setup.cfg"
	- "test/report.html"
	- "test-results/**"
	- "**/report.html"
	- "test/run_error_simulation_suite.py"
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: github-pages
	cancel-in-progress: true

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

	- name: Checkout reports branch
	uses: actions/checkout@v4
	with:
	ref: reports
	path: _reports
	continue-on-error: true

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

	- name: Install documentation dependencies
	run: \|
	python -m pip install --upgrade pip
	python -m pip install -e ".[docs]"

	- name: Configure GitHub Pages
	uses: actions/configure-pages@v5

	- name: Build MkDocs site
	run: mkdocs build --strict

	- name: Copy test report into site
	run: mkdir -p site/test && cp test/report.html site/test/

	- name: Assemble test-results dashboard
	run: \|
	mkdir -p site/test-results
	if [ -f test-results/index.html ]; then
	cp -a test-results/index.html site/test-results/
	fi
	if [ -d _reports/test-results ]; then
	cp -a _reports/test-results/. site/test-results/
	fi

	- name: Upload GitHub Pages artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: site

	deploy:
	needs: build
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Navigation Menu