This project uses MkDocs. It is automatically built and hosted by Read the Docs at the following URL:
You need the following things installed:
- pip
- libjpeg (libjpeg-dev on ubuntu/Debian)
It is recommended that you use virtualenv if you want to run the build process locally.
To install the dependencies:
pip install -Ur requirements.txt
To preview your changes locally run:
mkdocs serve
Then visit:
Diagrams are generated by
blockdiag from .diag
source
files in diagrams/
.
To regenerate the diagrams:
- run
make
from the root directory - preview the diagram
- commit the changes to the SVG file
If you've added a new diagram, you'll need to edit diagrams/Makefile
.