how_to_build_docs.md

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

pip3 install mkdocs
pip3 install mkdocs-material
pip3 install mkdocs-git-revision-date-localized-plugin
pip3 install mkdocs-redirects

Build the Docs

mkdocs build

See the Docs

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:

mkdocs gh-deploy