Skip to content

Commit cc2a25b

Browse files
authored
Merge pull request #862 from kenjis/docs-HowToBuildDocs
docs: add "How to Build Shield Documentation"
2 parents 41fb00e + 16fb1e4 commit cc2a25b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

admin/how_to_build_docs.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# How to Build Shield Documentation
2+
3+
We use Material for MkDocs for our documentation.
4+
See https://squidfunk.github.io/mkdocs-material/getting-started/.
5+
6+
## Requirements
7+
8+
- Python3
9+
- pip
10+
11+
## Installation
12+
13+
```console
14+
pip3 install mkdocs
15+
pip3 install mkdocs-material
16+
pip3 install mkdocs-git-revision-date-localized-plugin
17+
```
18+
19+
## Build the Docs
20+
21+
```consolse
22+
mkdocs build
23+
```
24+
25+
## See the Docs
26+
27+
```consolse
28+
mkdocs serve
29+
```
30+
31+
## Deploy Manually
32+
33+
The documentation is built and deployed automatically by GitHub Actions. But if
34+
you need to deploy manually, run the following command:
35+
36+
```console
37+
mkdocs gh-deploy
38+
```

0 commit comments

Comments
 (0)