Docs

Create docs.yml #1

	name: Docs

	on:
	push:
	branches: [main]
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- '.github/workflows/docs.yml'
	pull_request:
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- '.github/workflows/docs.yml'
	workflow_dispatch:

	permissions:
	contents: read

	concurrency:
	group: docs-${{ github.ref }}
	cancel-in-progress: true

	jobs:
	build:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4

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

	- name: Install documentation dependencies
	run: python -m pip install -r docs/requirements.txt

	- name: Build site
	run: python -m mkdocs build --strict

	- name: Upload Pages artifact
	if: github.event_name != 'pull_request'
	uses: actions/upload-pages-artifact@v3
	with:
	path: site

	deploy:
	if: github.event_name != 'pull_request'
	needs: build
	runs-on: ubuntu-latest

	permissions:
	pages: write
	id-token: write

	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