-
Notifications
You must be signed in to change notification settings - Fork 0
39 lines (32 loc) · 1 KB
/
deploy_docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main # Trigger on push to main branch
jobs:
build-and-deploy:
strategy:
matrix:
python-version: [ 3.11 ] # Define Python version
os: [ ubuntu-latest ] # Define OS
runs-on: ${{ matrix.os }}
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r docs/requirements.txt
- name: Build docs
run: |
mkdocs build
mkdocs build # Build twice if needed
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site # Adjust if your site directory is elsewhere