Skip to content

build(deps): update pagefind requirement from >=1.0.0 to >=1.5.2 #27

build(deps): update pagefind requirement from >=1.0.0 to >=1.5.2

build(deps): update pagefind requirement from >=1.0.0 to >=1.5.2 #27

Workflow file for this run

name: Docs
on:
push:
branches: [main]
paths:
- "docs/**"
- "src/**"
- "pyproject.toml"
- ".github/workflows/docs.yml"
pull_request:
branches: [main]
paths:
- "docs/**"
- "src/**"
- "pyproject.toml"
- ".github/workflows/docs.yml"
workflow_dispatch:
concurrency:
group: docs-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
FORCE_COLOR: "1"
UV_SYSTEM_PYTHON: "1"
jobs:
# ============================================================================
# Build Documentation
# ============================================================================
build:
name: Build
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
- name: Set up Python
run: uv python install 3.12
- name: Install dependencies
run: uv sync --group docs
- name: Build documentation
run: |
uv run sphinx-build \
-b html \
--keep-going \
-v \
docs \
docs/_build/html
- name: Upload documentation artifact
uses: actions/upload-pages-artifact@v4
with:
path: docs/_build/html
# ============================================================================
# Deploy to GitHub Pages
# ============================================================================
deploy:
name: Deploy
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4