Skip to content

Commit 4e8cb62

Browse files
committed
feat(ci): add github action to generate documentation artifacts
1 parent 689406b commit 4e8cb62

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/workflows/docs.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: docs
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "docs/**"
7+
- ".readthedocs.yml"
8+
push:
9+
branches: [main]
10+
paths:
11+
- "docs/**"
12+
- ".readthedocs.yml"
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/setup-python@v5
20+
with:
21+
python-version: "3.11"
22+
- name: Install dependencies
23+
run: pip install -r docs/requirements-docs.txt
24+
- name: Build docs
25+
run: sphinx-build -W --keep-going -b html docs docs/_build/html
26+
- uses: actions/upload-artifact@v4
27+
if: always()
28+
with:
29+
name: docs-html
30+
path: docs/_build/html
31+
retention-days: 7

0 commit comments

Comments
 (0)