Skip to main content

Checks code blocks in reStructuredText.

Project description

Build status

Checks code blocks in reStructuredText.

This is in addition to the usual docutils reStructuredText syntax check itself.

Installation

From pip:

$ pip install --upgrade rstcheck

Supported languages in code blocks

  • Bash

  • C (C99)

  • C++ (C++11)

  • Python

  • reStructuredText

Example

With bad Python syntax:

====
Test
====

.. code-block:: python

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

With bad C++ syntax:

====
Test
====

.. code-block:: cpp

    int main()
    {
        return x;
    }
$ rstcheck bad_cpp.rst
bad_cpp.rst:9: (ERROR/3) (cpp) 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.5.tar.gz (5.0 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for rstcheck-0.3.5.tar.gz
Algorithm Hash digest
SHA256 8490f0cb152e3575b554075d3cd6c2706596b317cab1239c714ef2bdd1b2290f
MD5 c0baf953bb0545a6b9503c8530c34457
BLAKE2b-256 31100cb623ac141ee6b80fed4177f3fcffb937a71bb553d74e279ea9876cd350

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