llmsql-benchmark/.github/workflows/docs.yml at fb4a5f44b4cb9233f400baa64619c427217f8358 · LLMSQL/llmsql-benchmark · 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
name: Build & Deploy Sphinx Docs

on:
  push:
    branches:
      - page
      - main
  pull_request:
    branches:
      - main

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.11"

      - name: Install PDM
        run: pip install pdm

      - name: Cache PDM packages
        uses: actions/cache@v4
        with:
          path: ~/.cache/pdm
          key: ${{ runner.os }}-pdm-${{ hashFiles('pdm.lock') }}
          restore-keys: |
            ${{ runner.os }}-pdm-

      - name: Install dependencies (with dev)
        run: pdm install --with dev,vllm

      - name: Build Sphinx docs
        run: |
          cd docs
          PYTHONPATH=.. pdm run python -m sphinx -b html . _build/html

      - name: Upload artifact (HTML for preview)
        uses: actions/upload-artifact@v4
        with:
          name: docs-html
          path: docs/_build/html

  preview:
    if: github.ref == 'refs/heads/page'
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Download built docs
        uses: actions/download-artifact@v4
        with:
          name: docs-html
          path: ./docs/_build/html

      - name: Configure GitHub Pages preview
        uses: actions/configure-pages@v4

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/_build/html

      - name: Deploy preview
        id: deployment
        uses: actions/deploy-pages@v4

  deploy:
    if: github.ref == 'refs/heads/main'
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Download built docs
        uses: actions/download-artifact@v4
        with:
          name: docs-html
          path: ./docs/_build/html

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/_build/html

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4