Skip to content

Build our Website using mkdocs

The website is hosted at artery.v2x-research.eu. The latest version is always included in our main git repository. Raphael updates the website from time to time, i.e. when changes have been committed.

Installing Dependencies

PEP 668 recommends to install Python dependencies in a virtual environment. We propose the following steps when in the root directory: 

python3 -m venv venv
venv/bin/pip install -r docs/requirements.txt

Build or Serve

You can build the website from the root directory where mkdocs.yml is located by calling: 

venv/bin/mkdocs build
This will generate the website in the www directory.

Alternatively, you can start a temporary webserver delivering the website locally with: 

venv/bin/mkdocs serve

Last update: August 20, 2023