Skip to content

Verification · Static analysis

Documentation build

Builds documentation as a check so broken cross-references, links and markup fail like code.

Sub-techniques

Strict docs build V1010.001

Treat warnings as errors (sphinx -W, mkdocs --strict).
Link checking V1010.002

Check internal and external links on a schedule.
Doctests V1010.003

Run code examples in documentation as tests.

How to build it

Build docs in CI with warnings as errors.
Run a link checker on PRs for internal links and weekly for external ones.
Execute examples so docs and code cannot drift.

Signals in a repository

docs/conf.py or mkdocs.yml plus a CI docs job.
A lychee or linkcheck step, or doctest options in pytest config.