InfraSonar documentation

This is the repository for the InfraSonar documentation. It makes use of MkDocs and the Material theme.

---

Installation

Local

Installing the required pip packages:

pip install -r requirements.txt

Start the server:

mkdocs serve

Docker

The following commands build the site and start the server on http://127.0.0.1:8000 Observe we overwrite the path with our local path, this allows for live updates while making modifications to the site.

docker build -t infrasonardocs .
docker run --rm --volume="$PWD:/usr/src/app" -p 8000:8000 infrasonardocs

Editing

• Find supported emojis

Deploying

Building should be done by creating a new version tag. This will trigger a gh-action which executes mkdocs gh-deploy.

git tag v0.1.0
git push origin v0.1.0