Skip to content

Commit cf91477

Browse files
authored
Building docs in pipeline (#110)
* doc building * making it required * fixing make
1 parent 7abb589 commit cf91477

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Build Docs
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build-docs:
11+
runs-on: ubuntu-22.04
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
16+
- name: Install uv
17+
uses: astral-sh/setup-uv@v4
18+
19+
- name: Set up Python
20+
run: uv python install 3.9
21+
22+
- name: Install project dependencies
23+
run: uv sync
24+
25+
- name: Install docs dependencies
26+
run: uv pip install -r docs/requirements.txt
27+
28+
- name: Build docs
29+
run: |
30+
cd docs
31+
uv run make html SPHINXOPTS="-W --keep-going"
32+
33+
- name: Upload docs artifact
34+
uses: actions/upload-artifact@v4
35+
with:
36+
name: docs-html
37+
path: docs/build/html

0 commit comments

Comments
 (0)