File tree Expand file tree Collapse file tree 1 file changed +21
-1
lines changed Expand file tree Collapse file tree 1 file changed +21
-1
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,12 @@ OpenSSL Documentation website is based on
4
4
[ Material for MkDocs] ( https://squidfunk.github.io/mkdocs-material/ ) and
5
5
this repository contains required configuration and build scripts.
6
6
7
+ ## Deployment
8
+
9
+ To deploy documentation website manually trigger
10
+ [ Deploy site] ( https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml ) GitHub
11
+ Actions workflow.
12
+
7
13
## Local development
8
14
9
15
All required dependencies are packed into a container image ` quay.io/openssl-ci/docs ` .
@@ -32,8 +38,22 @@ To start playing around you can spin up a container and run commands:
32
38
mike serve -a 0.0.0.0:8000
33
39
```
34
40
35
- # # Deployment
41
+ # # build.py
42
+
43
+ A small wrapper script to clone a specific OpenSSL branch and build documentaton website with
44
+ ` mike` . Run it to build the website:
45
+
46
+ ` ` ` sh
47
+ python build.py < OPENSSL VERSION>
48
+ ` ` `
49
+
50
+ ` mike` puts generated content into a separate branch ` gh-pages` . Please refer ` mike`
51
+ [documentation](https://github.com/jimporter/mike) for the details.
52
+
53
+ # # hooks.py
36
54
55
+ All pre- and post- processing is done via ` MkDocs` hooks. Please refer ` MkDocs`
56
+ [documentation](https://www.mkdocs.org/dev-guide/plugins/# events) for the details.
37
57
38
58
39
59
# # References
You can’t perform that action at this time.
0 commit comments