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
|
name: Build Documentation
on:
push:
branches:
- master
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "documentation"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Configure Python
uses: actions/setup-python@v6
with:
python-version: "3.10"
- name: Configure dependencies
run: |
pip install --user --upgrade pip
pip install --user pipx
pipx ensurepath
pipx install sphinx==5.3.0
pipx inject sphinx pyjwt cryptography sphinx-mdinclude sphinx-rtd-theme sphinx-autodoc-typehints
- name: Build documentation
run: |
sphinx-build ./docs/source ./docs/build --keep-going -n -a -b html
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: "./docs/build"
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: "github-pages"
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
|
