GOV.UK PaaS Team Manual

This project uses MkDocs. It is automatically built and hosted by Read the Docs at the following URL:

Setup

You need the following things installed:

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:

If you've added a new diagram, you'll need to edit diagrams/Makefile.