WaveBench/.github/workflows/docs.yml at master · Scaxlibur/WaveBench · 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
name: Documentation

on:
  push:
    branches: [master, main, Dev]
    paths:
      - ".agents/skills/wavebench-docs/**"
      - ".github/workflows/docs.yml"
      - "CHANGELOG.md"
      - "README.md"
      - "docs/**"
      - "mkdocs.yml"
      - "plans/**"
      - "pyproject.toml"
      - "uv.lock"
      - "scripts/docs_impact.py"
      - "scripts/generate_docs.py"
      - "src/wavebench/**"
      - "wavebench.example.toml"
  pull_request:
    paths:
      - ".agents/skills/wavebench-docs/**"
      - ".github/workflows/docs.yml"
      - "CHANGELOG.md"
      - "README.md"
      - "docs/**"
      - "mkdocs.yml"
      - "plans/**"
      - "pyproject.toml"
      - "uv.lock"
      - "scripts/docs_impact.py"
      - "scripts/generate_docs.py"
      - "src/wavebench/**"
      - "wavebench.example.toml"
  workflow_dispatch:
  workflow_call:

permissions:
  contents: read

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 2

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

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

      - name: Install documentation dependencies
        run: uv sync --locked --python 3.11 --extra dev --extra docs

      - name: Check generated Reference
        run: uv run --no-sync python scripts/generate_docs.py --check

      - name: Audit documentation
        run: uv run --no-sync python .agents/skills/wavebench-docs/scripts/audit_docs.py --quiet-warnings

      - name: Build site
        run: uv run --no-sync mkdocs build --strict

      - name: Report documentation impact
        run: uv run --no-sync python scripts/docs_impact.py

      - uses: actions/upload-artifact@v4
        with:
          name: documentation-site
          path: site/
          if-no-files-found: error