Skip to content

docs: Add How-To guide for scaffolding a QType project with cookiecut… #50

docs: Add How-To guide for scaffolding a QType project with cookiecut…

docs: Add How-To guide for scaffolding a QType project with cookiecut… #50

Workflow file for this run

name: Deploy Docs to GitHub Pages
on:
# Allow manual trigger
workflow_dispatch:
# Trigger on push to main when docs directory changes
push:
branches:
- main
paths:
- 'docs/**'
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:
deploy:
name: Deploy Docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: Install dependencies
run: uv sync --group dev
- name: Build documentation
run: uv run mkdocs build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4