File tree Expand file tree Collapse file tree 5 files changed +48
-41
lines changed Expand file tree Collapse file tree 5 files changed +48
-41
lines changed Original file line number Diff line number Diff line change @@ -30,6 +30,4 @@ assignees: ''
30
30
31
31
## Configuration
32
32
33
- <!-- Which container image are you using? -->
34
-
35
33
<!-- What system are you using it on? -->
Original file line number Diff line number Diff line change @@ -11,16 +11,6 @@ assignees: ''
11
11
12
12
<!-- What new package would you like in glotzerlab-software? -->
13
13
14
- ## Ubuntu package
15
-
16
- <!-- What is the name of the ubuntu package? -->
17
- <!-- Search the `bionic` distribution https://packages.ubuntu.com/ -->
18
-
19
14
## Additional context
20
15
21
16
<!-- What additional information is helpful to understand this request? -->
22
-
23
- ## Developer
24
-
25
- <!-- Who should add the software to the build scripts? -->
26
- <!-- Suggestion: You can contribute the changes as a PR: see `README.md` -->
Original file line number Diff line number Diff line change @@ -21,30 +21,3 @@ updates:
21
21
applies-to : security-updates
22
22
patterns :
23
23
- ' *'
24
- - package-ecosystem : " pip"
25
- directory : " /doc"
26
- target-branch : trunk
27
- schedule :
28
- interval : " monthly"
29
- time : " 07:00"
30
- timezone : " EST5EDT"
31
- pull-request-branch-name :
32
- separator : " -"
33
- open-pull-requests-limit : 2
34
- reviewers :
35
- - joaander
36
- groups :
37
- pip-version :
38
- applies-to : version-updates
39
- patterns :
40
- - ' *'
41
- update-types :
42
- - minor
43
- - patch
44
- pip-security :
45
- applies-to : security-updates
46
- patterns :
47
- - ' *'
48
- update-types :
49
- - minor
50
- - patch
Original file line number Diff line number Diff line change
1
+ name : doc
2
+
3
+ concurrency :
4
+ group : ${{ github.workflow }}-${{ github.ref }}
5
+ cancel-in-progress : true
6
+
7
+ on :
8
+ pull_request :
9
+ push :
10
+ branches :
11
+ - " trunk"
12
+
13
+ workflow_dispatch :
14
+
15
+ defaults :
16
+ run :
17
+ shell : bash
18
+
19
+ env :
20
+ CARGO_TERM_COLOR : always
21
+ CLICOLOR : 1
22
+ MDBOOK_VERSION : 0.4.37
23
+ LINKCHECK_VERSION : 0.7.7
24
+
25
+ jobs :
26
+ build_documentation :
27
+ name : Build documentation
28
+ runs-on : ubuntu-22.04
29
+ steps :
30
+ - uses : actions/checkout@v4.1.3
31
+ - name : Install mdbook
32
+ run : |
33
+ mkdir -p "$HOME/.cargo/bin"
34
+ curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v$MDBOOK_VERSION/mdbook-v$MDBOOK_VERSION-x86_64-unknown-linux-gnu.tar.gz" | tar -xvz --directory "$HOME/.cargo/bin"
35
+ - name : Install mdbook-linkcheck
36
+ run : |
37
+ curl -sSL "https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v$LINKCHECK_VERSION/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip" -o mdbook-linkcheck.zip
38
+ unzip mdbook-linkcheck.zip -d "$HOME/.cargo/bin"
39
+ chmod a+x "$HOME/.cargo/bin/mdbook-linkcheck"
40
+ - name : Add linkcheck configuration
41
+ run : |
42
+ echo -e "[output.linkcheck]\nfollow-web-links=true" >> doc/book.toml
43
+ cat doc/book.toml
44
+ - name : Build documentation
45
+ run : mdbook build doc
46
+ env :
47
+ RUST_LOG : " mdbook=info,linkcheck=warn,reqwest=debug"
Original file line number Diff line number Diff line change @@ -56,9 +56,8 @@ build will contain the cluster name and a `gpu` or `cpu` suffix. For example:
56
56
## Contributing
57
57
58
58
Contributions are welcomed via [ pull requests] . Please report bugs and suggest feature
59
- enhancements via the [ issue tracker] . See [ ARCHITECTURE.md] for information on how the
59
+ enhancements via the [ issue tracker] . See ` ARCHITECTURE.md ` for information on how the
60
60
repository is structured, including how to modify the containers.
61
61
62
62
[ pull requests ] : https://github.com/glotzerlab/software/pulls
63
63
[ issue tracker ] : https://github.com/glotzerlab/software/issues
64
- [ ARCHITECTURE.md ] : ARCHITECTURE.md
You can’t perform that action at this time.
0 commit comments