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 details)

Uploaded Source

File details

Details for the file rstcheck-0.3.3.tar.gz.

File metadata

  • Download URL: rstcheck-0.3.3.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rstcheck-0.3.3.tar.gz
Algorithm Hash digest
SHA256 fa6390c3b4e388b020411ef20eff80b9a540d2b2cf3ba4ac528370a04505faae
MD5 bbc71664fe9d66cfd762efcc61e82286
BLAKE2b-256 568db36145a36ef14384f235fbb32ed2498b0e12405b6aa3662a8ca5a10a4acd

See more details on using hashes here.

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