FICHA · MANJARO

python-rstcheck-core

Checks syntax of reStructuredText and code blocks nested within it

  • development-tool
  • Dev
  • DOCS
  • CLI
  • Launchable
  • Runs in terminal
official+codex · reviewed · May 28, 2026 description in en

Description

Checks reStructuredText documents and code blocks embedded inside them for syntax problems. It helps documentation projects catch broken markup, invalid directives, and examples that may fail before publishing.

Developers and documentation maintainers use it in editors, pre-commit hooks, or CI jobs. It can report issues early, but generated documentation should still be built and reviewed in its final rendered form.

How to run

rstcheck

Commands: rstcheck

Permissions

Permissions not analysed for this source yet.