Skip to content

Commit 839e025

Browse files
Copilotdjw8605
andcommitted
Add GitHub workflow to test documentation building
Co-authored-by: djw8605 <[email protected]>
1 parent a83c48d commit 839e025

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

.github/workflows/docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Documentation Build Test
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
10+
11+
jobs:
12+
build-docs:
13+
runs-on: ubuntu-latest
14+
name: Build Documentation
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
with:
19+
submodules: recursive
20+
21+
- name: Set up Python
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: '3.11'
25+
26+
- name: Install system dependencies
27+
run: |
28+
sudo apt-get update
29+
sudo apt-get install -y doxygen
30+
31+
- name: Install Python dependencies
32+
run: |
33+
pip install -r docs/requirements.txt
34+
35+
- name: Build documentation
36+
working-directory: docs
37+
run: |
38+
make html
39+
40+
- name: Check for warnings and errors
41+
working-directory: docs
42+
run: |
43+
if [ -f _build/html/index.html ]; then
44+
echo "Documentation built successfully"
45+
echo "Generated files:"
46+
ls -la _build/html/
47+
else
48+
echo "Documentation build failed - index.html not found"
49+
exit 1
50+
fi
51+
52+
- name: Upload documentation artifacts
53+
uses: actions/upload-artifact@v3
54+
with:
55+
name: documentation
56+
path: docs/_build/html/
57+
retention-days: 7

0 commit comments

Comments
 (0)