KempnerForge/.github/workflows/docs.yml at main · KempnerInstitute/KempnerForge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
name: Docs

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "kempnerforge/**"
      - "pyproject.toml"
      - "uv.lock"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

# Allow only one concurrent deployment; cancel in-progress runs on new pushes
concurrency:
  group: "pages"
  cancel-in-progress: false

permissions:
  contents: read

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: astral-sh/setup-uv@v6
      - run: uv sync --group docs
      - run: uv run sphinx-build -W --keep-going -b html docs docs/_build/html
      - uses: actions/upload-pages-artifact@v3
        if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
        with:
          path: docs/_build/html

  deploy:
    if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4