Strict docs build

How to build it

1. Run sphinx-build with -W or mkdocs build with --strict in CI.
2. Fix existing warnings before turning the flag on.
3. Fail the docs job on broken references, missing navigation entries and bad markup.

Signals in a repository

• A docs job in CI running sphinx-build -W or mkdocs build --strict.
• A docs/conf.py or mkdocs.yml file in the repository.

In practice

19 repositories run a tool for this check in the scanned set.

• sphinx · 9 repos
• mkdocs · 11 repos

Examples

• TheAlgorithms/Python · sphinx

  sphinx-build -c docs . docs/_build/html

• pallets/flask · sphinx

  sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml

• traefik/traefik · mkdocs

  mkdocs build --strict

• astral-sh/ruff · mkdocs

  mkdocs build --strict -f mkdocs.yml

• celery/celery · sphinx

  sphinx-build -j2 -b apicheck -d {envtmpdir}/doctrees docs docs/_build/apicheck