FAQ | This is a LIVE service | Changelog

Skip to content

feat: add mkdocs template

Dr Rich Wareham requested to merge add-mkdocs-template into master

Add a new template to the common pipleine which builds documentation if a mkdocs.yml file is present in the root of the repository. Nothing is done if no file is present and all jobs can be disabled via variables which makes these jobs "safe" to add to the common pipeline.

If poetry is being used, dependencies are installed as per the pyproject.toml file otherwise documentation-specific requirements can be specified in a requirements.txt-formatted file.

This template has been tested with the regent house ballots application (job log) and the, non-Python, non-webapp, GitLab bots deployment project (job log).

Example changes to the regent house application can be found at https://gitlab.developers.cam.ac.uk/uis/devops/regent-house-ballots/ballots-webapp/-/merge_requests/21.

Edited by Dr Rich Wareham

Merge request reports