sdk/.github/workflows/docs.yaml at main · Shekharrajak/sdk · 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
name: Documentation

on:
  pull_request:
    paths:
      - "docs/**"
      - "kubeflow/**"
      - ".readthedocs.yaml"
      - ".github/workflows/docs.yaml"
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "kubeflow/**"
      - ".readthedocs.yaml"

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

jobs:
  build:
    runs-on: ubuntu-latest
    name: Build Documentation

    steps:
      - uses: actions/checkout@v6

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

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Build documentation
        run: |
          uv sync --group docs
          uv run sphinx-build -b html docs/source docs/_build/html

      - name: Upload documentation artifact
        uses: actions/upload-artifact@v6
        with:
          name: documentation
          path: docs/_build/html
          retention-days: 7

  linkcheck:
    runs-on: ubuntu-latest
    name: Check Links
    continue-on-error: true

    steps:
      - uses: actions/checkout@v6

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

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Check links
        run: |
          uv sync --group docs
          uv run sphinx-build -b linkcheck docs/source docs/_build/linkcheck || true