File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ name : Check Mkdocs Build
2+
3+ on :
4+ pull_request :
5+ branches : ["main"]
6+
7+ permissions :
8+ contents : read
9+
10+ jobs :
11+ deploy :
12+ runs-on : ubuntu-latest
13+ steps :
14+ - name : Checkout repo
15+ uses : actions/checkout@v4
16+
17+ - name : Configure Git credentials
18+ run : |
19+ git config user.name github-actions[bot]
20+ git config user.email 41898282+github-actions[bot]@users.noreply.github.com
21+
22+ - name : Configure cache ID
23+ run : echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
24+
25+ - name : Setup mkdocs material cache
26+ - uses : actions/cache@v3
27+ with :
28+ key : mkdocs-material-${{ env.cache_id }}
29+ path : .cache
30+ restore-keys : |
31+ mkdocs-material-
32+
33+ - name : Install uv and set the python version
34+ uses : astral-sh/setup-uv@v5
35+ with :
36+ enable-cache : true
37+
38+ - name : Retrieve Git submodules
39+ run : git submodule update --init --recursive && git submodule update --recursive --remote
40+
41+ - name : Copy examples into docs folder
42+ run : cp -r examples/ docs/examples/
43+
44+ - name : Install repo
45+ run : uv sync --extra docs
46+
47+ - name : Build docs
48+ run : mkdocs build
You can’t perform that action at this time.
0 commit comments