Skip to content

Bump astral-sh/setup-uv from 7.1.4 to 9.0.0 #50

Bump astral-sh/setup-uv from 7.1.4 to 9.0.0

Bump astral-sh/setup-uv from 7.1.4 to 9.0.0 #50

Workflow file for this run

name: Docs
# Deliberate deviation from the py-canon docs shim. The canon reusable workflow
# expects `docs/` as the Sphinx root with a `docs/conf.py` built from
# `py_canon.sphinx.configure`, but this repo's documentation lives in
# `docs/source/` and needs `nbsphinx` to render four tutorial notebooks, which the
# canon config does not enable. Adopting the shim as-is would silently stop
# publishing the notebooks.
on:
push:
branches: [main]
pull_request:
workflow_dispatch:
permissions:
contents: read
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: false
jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
steps:
- uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5
with:
fetch-depth: 0
persist-credentials: false
- name: Install uv
uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
with:
python-version: "3.12"
- name: Install pandoc (nbsphinx renders notebooks through it)
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install dependencies
run: uv sync --all-extras --all-groups
- name: Build documentation
run: uv run sphinx-build -b html --keep-going -E docs/source docs/_build/html
- name: Setup Pages
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
- name: Upload documentation artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
with:
path: ./docs/_build/html
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5
if: github.ref == 'refs/heads/main' && github.event_name == 'push'