Skip to content

Commit f5f4ea1

Browse files
committed
[action] Add action to test mkdocs build
1 parent 16a0ed4 commit f5f4ea1

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Check Mkdocs Build
2+
3+
on:
4+
pull_request:
5+
branches: ["main"]
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
check_mkdocs_build:
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: Install uv and set the python version
23+
uses: astral-sh/setup-uv@v5
24+
with:
25+
enable-cache: true
26+
27+
- name: Retrieve Git submodules
28+
run: git submodule update --init --recursive && git submodule update --recursive --remote
29+
30+
- name: Copy examples into docs folder
31+
run: cp -r examples/ docs/examples/
32+
33+
- name: Install repo
34+
run: uv sync --extra docs
35+
36+
- name: Build docs
37+
run: uv run mkdocs build

0 commit comments

Comments
 (0)