Checks syntax of reStructuredText and code blocks nested within it
Project Links
Meta
Author: Steven Myint
Maintainer: Christian Riedel
Requires Python: >=3.9
Classifiers
Topic
- Software Development :: Quality Assurance
General |
|
CI |
|
PyPI |
|
Github |
|
Library for checking syntax of reStructuredText and code blocks nested within it.
See the full documentation at read-the-docs
Installation
From pip
$ pip install rstcheck_core
To use pyproject.toml for configuration:
$ pip install rstcheck_core[toml]
To add sphinx support:
$ pip install rstcheck_core[sphinx]
To add YAML checking support:
$ pip install rstcheck_core[yaml]
Supported languages in code blocks
Bash
Doctest
C (C99)
C++ (C++11)
JSON
XML
Python
reStructuredText
YAML
1.2.2
Jun 01, 2025
1.2.1
Mar 23, 2024
1.2.0
Nov 13, 2023
1.1.1
Sep 09, 2023
1.1.0
Sep 09, 2023
1.0.3
Nov 12, 2022
1.0.2
May 30, 2022
1.0.1
May 30, 2022
1.0.0
May 29, 2022
1.0.0rc1
May 28, 2022