Skip to content

Docs

Docs #5

Workflow file for this run

name: Docs
# Publishes the documentation to GitHub Pages with each release, so the site
# matches the version on PyPI. Run it by hand to push documentation fixes
# between releases.
on:
push:
tags: ["v*"]
workflow_dispatch:
permissions:
contents: read
# Never let two deployments overlap.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: astral-sh/setup-uv@v6
with:
python-version: "3.12"
- name: Build documentation
run: uv run --locked --group docs zensical build --clean
- 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 }}
permissions:
pages: write
id-token: write
steps:
- id: deployment
uses: actions/deploy-pages@v4