-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #862 from kenjis/docs-HowToBuildDocs
docs: add "How to Build Shield Documentation"
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# How to Build Shield Documentation | ||
|
||
We use Material for MkDocs for our documentation. | ||
See https://squidfunk.github.io/mkdocs-material/getting-started/. | ||
|
||
## Requirements | ||
|
||
- Python3 | ||
- pip | ||
|
||
## Installation | ||
|
||
```console | ||
pip3 install mkdocs | ||
pip3 install mkdocs-material | ||
pip3 install mkdocs-git-revision-date-localized-plugin | ||
``` | ||
|
||
## Build the Docs | ||
|
||
```consolse | ||
mkdocs build | ||
``` | ||
|
||
## See the Docs | ||
|
||
```consolse | ||
mkdocs serve | ||
``` | ||
|
||
## Deploy Manually | ||
|
||
The documentation is built and deployed automatically by GitHub Actions. But if | ||
you need to deploy manually, run the following command: | ||
|
||
```console | ||
mkdocs gh-deploy | ||
``` |