how_to_build_docs.md

How to Build the Documentation

We use Material for MkDocs for our documentation. See https://squidfunk.github.io/mkdocs-material/getting-started/.

Requirements

• Python 3
• pip

Installation

Install Material for MkDocs, which brings MkDocs with it, into the venv virtual environment:

make install

The pinned version is in requirements.txt.

Build the Docs

Convert the user guide first (see the README), then build it:

make build

This runs mkdocs build --strict, which fails on a broken link or a nav entry without a page.

See the Docs

make serve

Without make, run the same steps by hand:

python3 -m venv venv
venv/bin/pip install -r requirements.txt
venv/bin/mkdocs build --strict
venv/bin/mkdocs serve

This repository does not deploy the documentation. Publishing happens in CodeIgniter4 once the converted guide moves there.