|
1 | 1 | name: sphinx
|
2 | 2 |
|
3 | 3 | on:
|
4 |
| - # Triggers the workflow on push or pull request events but only for the "master" branch |
5 | 4 | push:
|
6 | 5 | branches: ["master"]
|
7 | 6 | pull_request:
|
8 | 7 | branches: ["master"]
|
9 |
| - # Or manually from the Actions tab |
10 | 8 | workflow_dispatch:
|
11 | 9 |
|
12 |
| -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages |
13 | 10 | permissions:
|
14 | 11 | contents: read
|
15 | 12 | pages: write
|
16 | 13 | id-token: write
|
17 | 14 |
|
18 |
| -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. |
19 |
| -# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. |
20 | 15 | concurrency:
|
21 | 16 | group: "pages"
|
22 | 17 | cancel-in-progress: false
|
23 | 18 |
|
24 | 19 | jobs:
|
25 | 20 | build_docs:
|
26 |
| - runs-on: ubuntu-24.04-arm |
| 21 | + runs-on: ubuntu-latest |
27 | 22 | steps:
|
28 |
| - - uses: actions/checkout@v5 |
29 |
| - - uses: astral-sh/setup-uv@v6 |
30 |
| - - uses: actions/setup-python@v5 |
| 23 | + - name: Checkout repository |
| 24 | + uses: actions/checkout@v5 |
| 25 | + |
| 26 | + - name: Setup uv |
| 27 | + uses: astral-sh/setup-uv@v6 |
| 28 | + |
| 29 | + - name: Setup Python |
| 30 | + uses: actions/setup-python@v5 |
31 | 31 | with:
|
32 |
| - python-version: 3.13 |
| 32 | + python-version: "3.13" |
33 | 33 | allow-prereleases: true
|
34 |
| - - run: uv sync --group=docs |
35 |
| - - uses: actions/configure-pages@v5 |
36 |
| - - run: uv run sphinx-build -c docs . docs/_build/html |
37 |
| - - uses: actions/upload-pages-artifact@v4 |
| 34 | + cache: "pip" |
| 35 | + |
| 36 | + - name: Install docs dependencies |
| 37 | + run: uv sync --group=docs |
| 38 | + |
| 39 | + - name: Configure GitHub Pages |
| 40 | + uses: actions/configure-pages@v5 |
| 41 | + |
| 42 | + - name: Build Sphinx documentation |
| 43 | + run: uv run sphinx-build -c docs . docs/_build/html |
| 44 | + |
| 45 | + - name: Upload build artifact |
| 46 | + uses: actions/upload-pages-artifact@v4 |
38 | 47 | with:
|
39 | 48 | path: docs/_build/html
|
40 | 49 |
|
|
46 | 55 | needs: build_docs
|
47 | 56 | runs-on: ubuntu-latest
|
48 | 57 | steps:
|
49 |
| - - uses: actions/deploy-pages@v4 |
| 58 | + - name: Deploy to GitHub Pages |
50 | 59 | id: deployment
|
| 60 | + uses: actions/deploy-pages@v4 |
| 61 | + |
0 commit comments