Skip to content

Commit 6e4154b

Browse files
Add GitHub Actions workflow for Docs deployment
1 parent ec4c4c6 commit 6e4154b

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

.github/workflows/main.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Set up Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: "3.10"
18+
19+
- name: Install dependencies
20+
run: |
21+
pip install sphinx sphinx_rtd_theme
22+
# add more dependencies if needed (e.g., numpydoc, myst_parser)
23+
24+
- name: Build HTML
25+
run: |
26+
cd docs
27+
make html
28+
29+
- name: Deploy to GitHub Pages
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: ./docs/_build/html

0 commit comments

Comments
 (0)