File tree Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Original file line number Diff line number Diff line change
1
+ name : Deploy Documentation
2
+
3
+ on :
4
+ push :
5
+ branches :
6
+ - main
7
+ paths :
8
+ - ' docs/**'
9
+ - ' mkdocs.yml'
10
+ - ' .github/workflows/docs.yml'
11
+ workflow_dispatch :
12
+
13
+ permissions :
14
+ contents : read
15
+ pages : write
16
+ id-token : write
17
+
18
+ concurrency :
19
+ group : " pages"
20
+ cancel-in-progress : false
21
+
22
+ jobs :
23
+ build :
24
+ runs-on : ubuntu-latest
25
+ steps :
26
+ - uses : actions/checkout@v4
27
+
28
+ - name : Setup Python
29
+ uses : actions/setup-python@v4
30
+ with :
31
+ python-version : ' 3.8'
32
+
33
+ - name : Install dependencies
34
+ run : |
35
+ pip install mkdocs mkdocs-material
36
+ pip install mkdocstrings[python] pymdown-extensions
37
+
38
+ - name : Build documentation
39
+ run : mkdocs build
40
+
41
+ - name : Upload artifact
42
+ uses : actions/upload-pages-artifact@v2
43
+ with :
44
+ path : ./site
45
+
46
+ deploy :
47
+ environment :
48
+ name : github-pages
49
+ url : ${{ steps.deployment.outputs.page_url }}
50
+ runs-on : ubuntu-latest
51
+ needs : build
52
+ steps :
53
+ - name : Deploy to GitHub Pages
54
+ id : deployment
55
+ uses : actions/deploy-pages@v3
You can’t perform that action at this time.
0 commit comments