Docs

[DOCS]: Add Github Pages workflow #3

	name: Docs

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]
	workflow_dispatch:

	concurrency:
	group: pages-${{ github.ref }}
	cancel-in-progress: false

	permissions: {}

	jobs:
	build:
	name: Build docs
	runs-on: ubuntu-latest
	timeout-minutes: 10
	permissions:
	contents: read
	steps:
	- name: Checkout
	uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
	with:
	persist-credentials: false

	- name: Set up Python
	uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
	with:
	python-version: "3.12"

	- name: Set up uv
	uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
	with:
	enable-cache: true

	- name: Install docs dependencies
	run: uv sync --only-group docs --frozen

	- name: Build site
	run: uv run mkdocs build --strict --site-dir _site

	- name: Upload Pages artifact
	if: github.event_name != 'pull_request'
	uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
	with:
	path: _site

	deploy:
	name: Deploy docs
	if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
	needs: build
	runs-on: ubuntu-latest
	timeout-minutes: 10
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy
	id: deployment
	uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

Navigation Menu