Warning This document has not been updated for a while now. It may be out of date.Last updated: 8 Nov 2021
govuk-wuj-network-analysis: `docs` folder overview
All documentation for the project should be included in this folder in either reStructuredText or Markdown files, with acceptable formatting for Sphinx. Guidance on how to write Sphinx documentation is supplied in the contributor guide.
To build the documentation, run the
docs command from
Makefile using the
utility at the top-level of this repository.
or, alternatively, run:
sphinx-build -b linkcheck ./docs ./docs/_build
The HTML-version of this documentation can then be viewed at
relative to the top-level of this repository.
Analytical quality assurance (AQA)
All analytical quality assurance (AQA) documents can be found in the
These files document how this project meets organisational guidance on producing
quality analysis for HM Government projects.