swiflow/.github/workflows/doc.yml at master · TeamGraphix/swiflow · 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
name: doc

on: [push, pull_request, workflow_dispatch]

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build_docs:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - run: rustup update

      - uses: astral-sh/setup-uv@v6
        with:
          python-version: "3.13"

      - run: |
          uv sync --extra dev --extra doc

      - run: |
          uv run sphinx-build docs/source docs/build -W -a

      - uses: actions/upload-artifact@v4
        with:
          name: html-docs
          path: ./docs/build

      - uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/build
          retention-days: "1"

  deploy_docs:
    runs-on: ubuntu-latest

    needs: build_docs

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}

    steps:
      - uses: actions/deploy-pages@v4
        id: deployment