Skip to content

Commit a59ee73

Browse files
authored
Create deploy_mkdocs
1 parent 4cc34f1 commit a59ee73

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/workflows/deploy_mkdocs

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
# Checkout the repository
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
# Set up Python
18+
- name: Setup Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: '3.x'
22+
23+
# Install dependencies
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install mkdocs mkdocs-material mkdocstrings-python
28+
29+
# Build the MkDocs site
30+
- name: Build and Publish MkDocs site
31+
run: mkdocs gh-deploy

0 commit comments

Comments
 (0)