Skip to content

Commit

Permalink
Merge pull request #862 from kenjis/docs-HowToBuildDocs
Browse files Browse the repository at this point in the history
docs: add "How to Build Shield Documentation"
  • Loading branch information
datamweb authored Sep 29, 2023
2 parents 41fb00e + 16fb1e4 commit cc2a25b
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions admin/how_to_build_docs.md
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
```

0 comments on commit cc2a25b

Please sign in to comment.