File tree Expand file tree Collapse file tree 6 files changed +422
-12
lines changed Expand file tree Collapse file tree 6 files changed +422
-12
lines changed Original file line number Diff line number Diff line change 8
8
paths :
9
9
- ' docs/**'
10
10
- ' .github/workflows/documentation.yml'
11
- - ' mkdocs.yml'
12
11
pull_request :
13
12
branches :
14
13
- main
15
14
paths :
16
15
- ' docs/**'
17
16
- ' .github/workflows/documentation.yml'
18
- - ' mkdocs.yml'
19
17
20
18
permissions :
21
19
contents : write
@@ -28,24 +26,28 @@ jobs:
28
26
with :
29
27
fetch-depth : 0
30
28
31
- - uses : actions/setup-python@v4
29
+ - name : Set up Python
30
+ uses : actions/setup-python@v4
32
31
with :
33
32
python-version : ' 3.x'
34
- cache : pip
33
+ cache : ' pip'
34
+ cache-dependency-path : ' docs/requirements.txt'
35
35
36
36
- name : Install dependencies
37
+ working-directory : docs
37
38
run : |
38
- pip install mkdocs-material
39
- pip install mkdocs-git-revision-date-localized-plugin
40
- pip install mkdocs-minify-plugin
39
+ python -m pip install --upgrade pip
40
+ pip install -r requirements.txt
41
+
42
+ - name : Build Documentation
43
+ working-directory : docs
44
+ if : github.event_name == 'pull_request'
45
+ run : mkdocs build
41
46
42
47
- name : Deploy Documentation
48
+ working-directory : docs
43
49
if : github.event_name == 'push' && github.ref == 'refs/heads/main'
44
50
run : |
45
51
git config --global user.name "github-actions[bot]"
46
52
git config --global user.email "github-actions[bot]@users.noreply.github.com"
47
53
mkdocs gh-deploy --force
48
-
49
- - name : Build Documentation
50
- if : github.event_name == 'pull_request'
51
- run : mkdocs build
Original file line number Diff line number Diff line change @@ -384,3 +384,5 @@ $RECYCLE.BIN/
384
384
385
385
# ## Project Files ###
386
386
* .prof
387
+ # MkDocs generated files
388
+ site /
Original file line number Diff line number Diff line change
1
+ ---
2
+ extends : default
3
+ rules :
4
+ braces :
5
+ max-spaces-inside : 1
6
+ level : error
7
+ brackets :
8
+ max-spaces-inside : 1
9
+ level : error
10
+ line-length : disable
11
+ truthy : disable
12
+ ignore : |
13
+ .golangci.yaml
14
+ .trunk/*
15
+ docs/mkdocs.yml
You can’t perform that action at this time.
0 commit comments