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:

====
Test
====

.. code-block:: python

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

With bad C++ syntax:

====
Test
====

.. code-block:: cpp

    int main()
    {
        return x;
    }
$ rstcheck bad_cpp.rst
bad_cpp.rst:8: (ERROR/3)  error: 'x' was not declared in this scope

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.4.tar.gz (4.9 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for rstcheck-0.3.4.tar.gz
Algorithm Hash digest
SHA256 f59b15fa4e11d4b6b1b1436309bca622e955899f8fda5ee8ed59c1aba2549f69
MD5 5caf2684350546d2151c498cbee02d3b
BLAKE2b-256 a4b80b81d9cde4c18c5f645315218837e605fb314699d83918bd76d24fe5f498

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