-
Notifications
You must be signed in to change notification settings - Fork 0
42 lines (35 loc) · 993 Bytes
/
Copy pathdocs.yml
File metadata and controls
42 lines (35 loc) · 993 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
name: Deploy Documentation
on:
push:
branches: [main]
paths:
- "packages/pypath/docs/**"
- "packages/pypath/src/**"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: write
jobs:
deploy-docs:
name: Build & Deploy MkDocs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: |
pip install -e "packages/pypath[docs]"
pip install mkdocs-material "mkdocstrings[python]"
- name: Build docs
working-directory: packages/pypath/docs
run: mkdocs build --strict
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: packages/pypath/docs/site
publish_branch: gh-pages