-
Notifications
You must be signed in to change notification settings - Fork 0
65 lines (54 loc) · 1.4 KB
/
docs.yml
File metadata and controls
65 lines (54 loc) · 1.4 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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
name: Docs
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: 'pages'
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/setup-node@v6
with:
node-version: 22
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: '3.x'
- name: Prepare docs structure
run: |
npm run readme:sync
cp CONTRIBUTING.md docs/
cp CHANGELOG.md docs/
cp THIRD-PARTY-NOTICES.md docs/
- name: Install MkDocs and dependencies
run: |
pip install mkdocs-material
pip install mkdocstrings
pip install pymdown-extensions
- name: Build MkDocs site
run: mkdocs build --strict
- name: Upload build artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v4
with:
path: ./site
deploy:
needs: build
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
steps:
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4