Skip to content

Group documentation navigation sections #11

Group documentation navigation sections

Group documentation navigation sections #11

Workflow file for this run

name: Deploy MkDocs
on:
push:
branches: [develop]
paths:
- ".github/workflows/docs.yml"
- "docs/**"
- "mkdocs.yml"
- "pyproject.toml"
- "uv.lock"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: github-pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
enable-cache: true
cache-dependency-glob: uv.lock
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install documentation dependencies
run: uv sync --extra docs --locked
- name: Build documentation
run: uv run mkdocs build --strict
- 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