Welcome to rstcheck-core’s documentation!

General
CI
PyPI
Github

This is the documentation of rstcheck-core, the core library behind the CLI application rstcheck for checking the syntax of reStructuredText and code blocks nested within it.

Contents:

• Installation
  • Create virtual environment
  • Installation from PyPI
  • Installation from source
• Usage
  • Configuration
  • Library
• Workflows
  • Development
  • Releases

API Reference:

• API
  • rstcheck_core package

Miscellaneous:

• FAQ / Known limitations / Known issues
  • Known limitations
  • Known issues
• Migration-Guides
  • rstcheck v5 to rstcheck-core v1 (rc1)
• Changelog File
• Changelog
  • Unreleased
  • v1.2.2 (2025-06-01)
  • v1.2.1 (2024-03-23)
  • v1.2.0 (2023-11-13)
  • v1.1.1 (2023-09-09)
  • v1.1.0 (2023-09-09)
  • v1.0.3 (2022-11-12)
  • v1.0.2 (2022-05-30)
  • 1.0.1.post2 (2022-05-30)
  • 1.0.1.post1 (2022-05-30)
  • v1.0.1 (2022-05-30)
  • v1.0.0 (2022-05-29)
  • v1.0.0rc1 (2022-05-28)
• Authors
  • Author
  • Additional contributions by (sorted by name)
• License