-
-
Notifications
You must be signed in to change notification settings - Fork 2
49 lines (47 loc) · 1.1 KB
/
docs.yml
File metadata and controls
49 lines (47 loc) · 1.1 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
name: Document
on:
push:
branches: master
pull_request:
branches: [ master ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: actions/setup-python@v6
with:
python-version: '3.14'
- name: Install dependencies
run: |
pip install \
mkdocs \
mkdocs-git-revision-date-localized-plugin \
mkdocs-material \
mkdocstrings \
mkdocstrings-python
- name: Install package
run: |
pip install .
- name: Build documentation
run: |
mkdocs build
- uses: actions/upload-pages-artifact@v4
deploy:
concurrency:
group: "pages"
cancel-in-progress: true
if: ${{ github.ref == 'refs/heads/master' }}
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- id: deployment
uses: actions/deploy-pages@v4