This repository has been archived by the owner on Feb 20, 2025. It is now read-only.

deploy-docs #18

	name: deploy-docs

	on:
	workflow_dispatch:
	release:
	types: [ "published" ]

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
	# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
	concurrency:
	group: "pages"
	cancel-in-progress: false

	jobs:
	build:
	environment:
	name: github-pages
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ inputs.python_version }}
	- name: Install uv
	uses: astral-sh/setup-uv@v2
	- name: Install dependencies
	run: \|
	uv sync --only-group docs
	shell: bash
	- name: Build docs
	run: \|
	uv run mkdocs build
	shell: bash
	- name: Upload artifact
	id: deployment
	uses: actions/upload-pages-artifact@v3
	with:
	path: ./site
	deploy:
	needs: build
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	- name: Setup Pages
	uses: actions/configure-pages@v5
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback