This is the old Government PaaS Developer Docs system. We are transitioning to the new system (see https://github.com/alphagov/paas-tech-docs). If you need to make docs changes, make them in the new system, which will become the official documentation shortly.
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.
virtualenv env
source ./env/bin/activate
To install the dependencies:
pip install -Ur requirements.txt
To preview your changes locally run:
mkdocs serve
Then visit:
The only test at the moment is for broken internal links. You can test manually using
./check_links.sh
The script starts a mkdocs server of its own, and kills it afterwards.
The link checker will check whether internal links point to pages which actually exist. It won't check anchors (wummel/linkchecker#557) and won't do much more than check well-formedness for mailto links. It won't currently check links to external sites, but we can enable that functionality if we wish to later on.
Travis runs ./check_links.sh on each commit.