Awesome Reviewers

Technique · 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.