Checks syntax of reStructuredText and code blocks nested within it
Project Links
Meta
Author: Steven Myint
Maintainer: Christian Riedel
Requires Python: >=3.10
Classifiers
Topic
- Software Development :: Quality Assurance
General |
|
|
|
CI |
|
PyPI |
|
|
|
Github |
|
|
Checks syntax of reStructuredText and code blocks nested within it.
See the full documentation at read-the-docs
Installation
From pip
$ pip install rstcheckTo use pyproject.toml for configuration:
$ pip install rstcheck[toml]
To add sphinx support:
$ pip install rstcheck[sphinx]
Pre-commit Hook with Extras
To use rstcheck in a Git pre-commit hook with optional features:
Install pre-commit:
pip install pre-commit
Add to .pre-commit-config.yaml:
- repo: https://github.com/rstcheck/rstcheck rev: main # should be replaced with the current verison hooks: - id: rstcheck additional_dependencies: ['rstcheck[sphinx,toml]']Run pre-commit install to activate.
Supported languages in code blocks
Bash
Doctest
C (C99)
C++ (C++11)
JSON
XML
Python
reStructuredText
Examples
With bad Python syntax:
====
Test
====
.. code:: python
print($ rstcheck bad_python.rst
bad_python.rst:7: (ERROR/3) (python) unexpected EOF while parsingWith bad C++ syntax:
====
Test
====
.. code:: cpp
int main()
{
return x;
}$ rstcheck bad_cpp.rst
bad_cpp.rst:9: (ERROR/3) (cpp) error: 'x' was not declared in this scopeWith bad syntax in the reStructuredText document itself:
====
Test
===$ rstcheck bad_rst.rst
bad_rst.rst:1: (SEVERE/4) Title overline & underline mismatch.
6.3.0
Jul 28, 2026
6.2.5
Jun 01, 2025
6.2.4
Jul 07, 2024
6.2.3
Jul 07, 2024
6.2.2
Jul 07, 2024
6.2.1
Mar 23, 2024
6.2.0
Sep 09, 2023
6.1.2
Mar 12, 2023
6.1.1
Nov 12, 2022
6.1.0
Aug 14, 2022
6.0.0.post1
Jun 05, 2022
6.0.0
Jun 04, 2022
6.0.0rc3
May 28, 2022
6.0.0rc2
May 26, 2022
6.0.0rc1
May 21, 2022
6.0.0a2
May 20, 2022
6.0.0a1
May 13, 2022
5.0.0
Apr 17, 2022
4.1.0
Apr 16, 2022
4.0.0
Apr 15, 2022
3.5.0
Apr 14, 2022
3.4.0
Apr 12, 2022
3.3.1
Nov 09, 2018
3.3
Mar 17, 2018
3.2
Feb 17, 2018
3.1
Mar 08, 2017
3.0.1
Mar 02, 2017
3.0
Dec 19, 2016
2.2
Oct 11, 2016
2.1
Oct 11, 2016
2.0
Jul 27, 2016
1.5.1
Mar 29, 2016
1.5
Feb 03, 2016
1.4.2
Dec 16, 2015
1.4.1
Aug 16, 2015
1.4
Jun 26, 2015
1.3.1
Apr 14, 2015
1.3
Apr 11, 2015
1.2.1
Apr 11, 2015
1.2
Apr 11, 2015
1.1.1
Apr 05, 2015
1.1
Apr 03, 2015
1.0
Mar 14, 2015
0.6
Sep 25, 2014
0.5.1
Aug 23, 2014
0.5
Jun 01, 2014
0.4.1
May 31, 2014
0.4
May 24, 2014
0.3.6
Apr 12, 2014
0.3.5
Jan 25, 2014
0.3.4
Dec 29, 2013
0.3.3
Dec 28, 2013
0.3.2
Dec 27, 2013
