rstcheck

Checks syntax of reStructuredText and code blocks nested within it

These details have not been verified by PyPI

Project links

Project description

General
General
CI
PyPI
PyPI
Github
Github

Checks syntax of reStructuredText and code blocks nested within it.

See the full documentation at read-the-docs

Installation

From pip

$ pip install rstcheck

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:

====
Test
===

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

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

6.2.4

Jul 7, 2024

6.2.3

Jul 7, 2024

6.2.2

Jul 7, 2024

6.2.1

Mar 23, 2024

6.2.0

Sep 9, 2023

This version

6.1.2

Mar 12, 2023

6.1.1

Nov 12, 2022

6.1.0

Aug 14, 2022

6.0.0.post1

Jun 5, 2022

6.0.0

Jun 4, 2022

6.0.0rc3 pre-release

May 28, 2022

6.0.0rc2 pre-release

May 26, 2022

6.0.0rc1 pre-release

May 21, 2022

6.0.0a2 pre-release

May 20, 2022

6.0.0a1 pre-release

May 13, 2022

5.0.0

Apr 17, 2022

4.1.0

Apr 16, 2022

4.0.0

Apr 15, 2022

3.5.0

Apr 14, 2022

3.4.0

Apr 12, 2022

3.3.1

Nov 9, 2018

3.3

Mar 17, 2018

3.2

Feb 17, 2018

3.1

Mar 8, 2017

3.0.1

Mar 2, 2017

3.0

Dec 19, 2016

2.2

Oct 11, 2016

2.1

Oct 11, 2016

2.0

Jul 27, 2016

1.5.1

Mar 29, 2016

1.5

Feb 3, 2016

1.4.2

Dec 16, 2015

1.4.1

Aug 16, 2015

1.4

Jun 26, 2015

1.3.1

Apr 14, 2015

1.3

Apr 11, 2015

1.2.1

Apr 11, 2015

1.2

Apr 11, 2015

1.1.1

Apr 5, 2015

1.1

Apr 3, 2015

1.0

Mar 14, 2015

0.6

Sep 25, 2014

0.5.1

Aug 23, 2014

0.5

Jun 1, 2014

0.4.1

May 31, 2014

0.4

May 24, 2014

0.3.6

Apr 12, 2014

0.3.5

Jan 25, 2014

0.3.4

Dec 29, 2013

0.3.3

Dec 28, 2013

0.3.2

Dec 27, 2013

Download files

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

Source Distribution

rstcheck-6.1.2.tar.gz (16.6 kB view details)

Uploaded Mar 12, 2023 Source

Built Distribution

rstcheck-6.1.2-py3-none-any.whl (6.9 kB view details)

Uploaded Mar 12, 2023 Python 3

File details

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

File metadata

Download URL: rstcheck-6.1.2.tar.gz
Upload date: Mar 12, 2023
Size: 16.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.4.0 CPython/3.8.10 Linux/5.4.0-137-generic

File hashes

Hashes for rstcheck-6.1.2.tar.gz
Algorithm	Hash digest
SHA256	`f9cb07a72ef9a81d1e32187eae29b00a89421ccba1bde0b1652a08ed0923f61b`
MD5	`7c8848bcf8132f8dd61a247a28774155`
BLAKE2b-256	`4b0a1092b3000e15d257e15b481b49e5b257cc522ab05ff06010a4adb5fc4622`

See more details on using hashes here.

File details

Details for the file rstcheck-6.1.2-py3-none-any.whl.

File metadata

Download URL: rstcheck-6.1.2-py3-none-any.whl
Upload date: Mar 12, 2023
Size: 6.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.4.0 CPython/3.8.10 Linux/5.4.0-137-generic

File hashes

Hashes for rstcheck-6.1.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`4aaa46e0debc179f849807c453fa384fd2b75167faf5b1274115730805fab529`
MD5	`f3685279caf5bb3b75ea77de6805aac4`
BLAKE2b-256	`f5690db8d50cc3b0cc4f7887d15b3e72fcaa8517b56bba6e4d8677174271148d`