Skip to content

Commit 87f192c

Browse files
committed
Add documentation Github workflow
1 parent 1edd810 commit 87f192c

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

.github/workflows/ci-docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: "CI: Build and Deploy Docs"
2+
3+
on:
4+
push:
5+
branches: [master]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout Repository
12+
uses: actions/checkout@v4
13+
14+
- name: Setup Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: '3.12'
18+
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install -r docs/requirements-docs.txt
23+
24+
- name: Build docs
25+
run: |
26+
cd docs
27+
make html
28+
touch build/html/.nojekyll
29+
30+
- name: Deploy to GitHub Pages
31+
uses: peaceiris/actions-gh-pages@v3
32+
with:
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: docs/build/html

0 commit comments

Comments
 (0)