Skip to content

Commit c168d79

Browse files
committed
Add documentation deployment workflow
1 parent af8758a commit c168d79

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- mkdocs # Changed from main to mkdocs
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
- '.github/workflows/deploy-docs.yml'
11+
12+
permissions:
13+
contents: write
14+
15+
jobs:
16+
deploy:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
21+
- name: Set up Python
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: '3.10'
25+
26+
- name: Install dependencies
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install mkdocs-material mkdocs-minify-plugin
30+
31+
- name: Build documentation
32+
run: mkdocs build
33+
34+
- name: Deploy to GitHub Pages
35+
uses: peaceiris/actions-gh-pages@v3
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: ./site
39+
publish_branch: gh-pages

0 commit comments

Comments
 (0)