-
Notifications
You must be signed in to change notification settings - Fork 12
47 lines (38 loc) · 1.08 KB
/
docs.yml
File metadata and controls
47 lines (38 loc) · 1.08 KB
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
45
46
name: Deploy Documentation
on:
push:
branches: [main]
paths:
- 'docs/**'
- 'src/**'
- '.github/workflows/docs.yml'
workflow_dispatch: # 允许手动触发
permissions:
contents: write
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0 # 需要完整历史用于gh-pages分支
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
pip install -e .
- name: Build documentation
run: |
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
cname: # 如果使用自定义域名,在这里设置,例如: docs.example.com