-
Notifications
You must be signed in to change notification settings - Fork 21
44 lines (36 loc) · 939 Bytes
/
genarate-docs.yml
File metadata and controls
44 lines (36 loc) · 939 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
37
38
39
40
41
42
43
44
name: Generate and Publish Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: Generate documentation
run: |
mkdir -p docs
cp README.md docs/index.md
- name: Upload Documentation Artifact
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs