Skip to content

Commit 9e2913b

Browse files
committed
ci: add GitHub Actions workflow for docs deployment
1 parent 9148631 commit 9e2913b

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

.github/workflows/github-pages.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- develop
8+
release:
9+
types:
10+
- published
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
jobs:
18+
build-and-deploy:
19+
runs-on: ubuntu-22.04
20+
environment: github-pages
21+
steps:
22+
- name: Checkout code
23+
uses: actions/checkout@v4
24+
- name: Set up Python
25+
uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.12'
28+
- name: Install dependencies
29+
run: |
30+
python -m pip install --upgrade pip
31+
pip install -r docs/source/requirements.txt
32+
- name: Build documentation
33+
run: |
34+
cd docs
35+
make html
36+
- name: Disable Jekyll
37+
run: |
38+
touch docs/build/html/.nojekyll
39+
- name: Upload pages artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: docs/build/html
43+
- name: Deploy to GitHub Pages
44+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)