Documentation

Clone the repository

git clone https://github.com/eml-eda/messy

Change into the directory

cd messy

Open this folder in Visual Studio Code (or in the terminal)

Create a python virtual environment

python3 -m venv doc_env

Activate the virtual environment

source doc_env/bin/activate

Install the dependencies

pip3 install -r requirements.txt

Serve the documentation

mkdocs serve

Now you see something like this:

Serving on http://127.0.0.1:8000/

Visual Studio Code should automatically setup port forwarding. So you can simply open a browser and go to http://127.0.0.1:8000 to see the documentation.