GitHub - rstcheck/rstcheck: Checks syntax of reStructuredText and code blocks nested within it (original) (raw)

rstcheck

General
CI
PyPI
Github

Checks syntax of reStructuredText and code blocks nested within it.

See the full documentation at read-the-docs

Contents

• Installation
• Supported languages in code blocks
• Examples

Installation

From pip

To use pyproject.toml for configuration:

$ pip install rstcheck[toml]

To add sphinx support:

$ pip install rstcheck[sphinx]

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 parsing

With 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 scope

With bad syntax in the reStructuredText document itself:

$ rstcheck bad_rst.rst bad_rst.rst:1: (SEVERE/4) Title overline & underline mismatch.