Skip to content

Commit 444f327

Browse files
committed
Add GitHub Actions workflow for deploying documentation to GitHub Pages
1 parent 16ee581 commit 444f327

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Deploy Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Set up Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: '3.12'
22+
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install mkdocs==1.6.1
27+
pip install mkdocs-material==9.6.14
28+
pip install mkdocstrings[python]==1.16.10
29+
pip install mkdocs-autorefs==1.4.2
30+
pip install mkdocs-jupyter==0.25.1
31+
32+
33+
- name: Build docs
34+
run: mkdocs build
35+
36+
- name: Deploy to GitHub Pages
37+
uses: peaceiris/actions-gh-pages@v3
38+
with:
39+
github_token: ${{ secrets.GITHUB_TOKEN }}
40+
publish_dir: ./site
41+
force_orphan: true

0 commit comments

Comments
 (0)