Skip to content

Running Documentation Server

Pre-Requisites

The documentation requires python to be installed:
https://www.python.org/downloads/

Installation

The scripts below will create a python virtual environment, activate, install required dependencies and start local server

1
2
3
4
5
cd documentation
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
mkdocs serve

1
2
3
4
5
cd documentation
python -m venv .venv # Or `python3`, depending on python installation
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Running locally

Once installed, subsequent server starts can skip installation steps

1
2
3
cd documentation
.\.venv\Scripts\Activate.ps1
mkdocs serve

1
2
3
cd documentation
source .venv/bin/activate
mkdocs serve

The server will start at http://127.0.0.1:8000