Skip to content

Commit 4780447

Browse files
committed
Add workflow for automatic documentation build
1 parent c8160e1 commit 4780447

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

.github/workflows/docs.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Documentation Build
2+
3+
on:
4+
push:
5+
branches: ["master"]
6+
paths:
7+
- "docs/**"
8+
- "mkdocs.yml"
9+
- ".readthedocs.yaml"
10+
- "pyproject.toml"
11+
pull_request:
12+
types: [opened, synchronize, reopened, ready_for_review]
13+
paths:
14+
- "docs/**"
15+
- "mkdocs.yml"
16+
- ".readthedocs.yaml"
17+
- "pyproject.toml"
18+
19+
jobs:
20+
build-docs:
21+
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
27+
- name: Set up Python
28+
uses: actions/setup-python@v5
29+
with:
30+
python-version: '3.12'
31+
32+
- name: Install dependencies
33+
run: |
34+
pip install --upgrade pip
35+
pip install -e ".[dev]"
36+
37+
- name: Verify MkDocs configuration
38+
run: mkdocs --version
39+
40+
- name: Build documentation
41+
run: mkdocs build --strict
42+
43+
- name: Upload documentation artifacts
44+
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
45+
uses: actions/upload-artifact@v4
46+
with:
47+
name: documentation
48+
path: site/
49+
retention-days: 7
50+

0 commit comments

Comments
 (0)