Skip to main content

Checks code blocks in ReStructuredText.

Project description

Build status

Checks code blocks in reStructuredText.

Installation

From pip:

$ pip install --upgrade rstcheck

Supported languages in code blocks

  • Bash

  • C (C99)

  • C++ (C++11)

  • Python

Example

With bad Python syntax:

$ cat bad_python.rst
====
Test
====

.. code-block:: python

    print(
$ rstcheck bad_python.rst
bad_python.rst:5: (ERROR/3) unexpected EOF while parsing

With bad C++ syntax:

$ cat bad_cpp.rst
====
Test
====

.. code-block:: cpp

    #include <iostream>

    int main()
    {
$ rstcheck bad_cpp.rst
bad_cpp.rst:9: (ERROR/3)  error: expected '}' at end of input

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rstcheck-0.3.3.tar.gz (4.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page