MiniTorch/.github/workflows/docs.yml at main · BriceLucifer/MiniTorch · 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
name: Documentation

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

permissions:
  contents: read

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

jobs:
  build:
    name: Build MkDocs site
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6

      - name: Install uv
        uses: astral-sh/setup-uv@v9.0.0
        with:
          enable-cache: true

      - name: Install documentation dependencies
        run: uv sync --locked --group docs

      - name: Build documentation
        run: uv run --group docs mkdocs build --strict

      - name: Upload Pages artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v5
        with:
          path: site

  deploy:
    name: Deploy to GitHub Pages
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    needs: build
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy documentation
        id: deployment
        uses: actions/deploy-pages@v5