Skip to content

Commit 158e658

Browse files
committed
added a github action that publishes the docs to a github page on each push
1 parent e00e74e commit 158e658

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
6+
jobs:
7+
deploy:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
12+
- uses: actions/setup-python@v5
13+
with:
14+
python-version: '3.12'
15+
16+
- run: pip install mkdocs mkdocs-material
17+
18+
- run: mkdocs build
19+
20+
- uses: actions/upload-artifact@v4
21+
with:
22+
name: docs-${{ github.sha }}
23+
path: site/
24+
25+
- run: mkdocs gh-deploy --force

0 commit comments

Comments
 (0)