-
Notifications
You must be signed in to change notification settings - Fork 2
36 lines (29 loc) · 835 Bytes
/
docs.yml
File metadata and controls
36 lines (29 loc) · 835 Bytes
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
---
name: Generate and Deploy Documentation
on:
push:
branches:
- main # Or the branch you use for documentation
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
# Set up Python environment
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: 3.11
# Install dependencies
- name: Install dependencies
run: |
pip install mkdocs==1.5.3 mkdocs-material pymdown-extensions mkdocs-minify-plugin
# Build the MkDocs site
- name: Build MkDocs site
run: mkdocs build
# Deploy to GitHub Pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: site