This project is built using mkdocs.
It uses the material theme, and this page in their docs includes lots of very nice customisations for formatting documentation.
Use just run to run the MkDocs server.
This should install everything required.
There is also a dev container setup that allows running the site in Codespaces or locally with VSCode and Docker.
The ehrQL documentation is imported from the
ehrQL repo using the
mkdocs-multirepo-plugin and built alongside the docs in this repo. By default it uses the main branch. This can
be configured with the EHRQL_BRANCH environment variable:
EHRQL_BRANCH=my-branch just run
cohort-extractor used to be a documentation dependency. As cohort-extractor is now discontinued we wanted to remove this dependency, so the rendered HTML content has been committed to legacy/docs.