General

Maintenance - intended License Semantic Versioning - 2.0.0

Read the Docs - Build Status (latest)

CI

Test status Documentation status QA status pre-commit status

PyPI

PyPI - Package latest release PyPI - Supported Python Versions PyPI - Supported Implementations

PyPI - Format PyPI - Monthly downloads

Github

Github - Latest Release GitHub - Last Commit

Github - Stars Github - Forks Github - Contributors Github - Watchers

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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (6.3.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for Cielquan from gravatar.com Cielquan Avatar for myint from gravatar.com myint

Credits

Author: Steven Myint

Maintainer: Christian Riedel

License

MIT

Requires

Python >=3.8

Tags

restructuredtext rst linter static-analysis

Classifiers

Report project as malware

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rstcheck-6.2.2-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rstcheck-6.2.2.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for rstcheck-6.2.2.tar.gz
Algorithm Hash digest
SHA256 54a8cfa7dd8953556138ab6e8f9743c581217d9cf2b41c924ea7d2b7a003b072
MD5 c709f992bd9e915ee3332e82f7273810
BLAKE2b-256 3f6502532763f7cae660c7de6c7263dc560dc753e6512af666c9fe189ce3b53f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rstcheck-6.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for rstcheck-6.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fb149364a02dcd41ef368bbba9ae12b79fe500bff2e1565fe27a6406f379fbd5
MD5 3fcda79d25e046b3c0b8959664b70d5a
BLAKE2b-256 6075975cb2aa96ed80e0d63b3351513123b8db16813470dfa17dbe9b2cdc54b9

See more details on using hashes here.

Release history Release notifications | RSS feed

6.3.0

2 files

6.2.5

2 files

6.2.4

2 files

6.2.3

2 files

This release

6.2.2 This release

2 files

6.2.1

2 files

6.2.0

2 files

6.1.2

2 files

6.1.1

2 files

6.1.0

2 files

6.0.0.post1

2 files

6.0.0

2 files

Pre-release

6.0.0rc3

2 files

Pre-release

6.0.0rc2

2 files

Pre-release

6.0.0rc1

2 files

Pre-release

6.0.0a2

2 files

Pre-release

6.0.0a1

2 files

5.0.0

2 files

4.1.0

2 files

4.0.0

2 files

3.5.0

2 files

3.4.0

2 files

3.3.1

1 file

3.3

1 file

3.2

1 file

3.1

1 file

3.0.1

1 file

3.0

1 file

2.2

1 file

2.1

1 file

2.0

1 file

1.5.1

1 file

1.5

1 file

1.4.2

1 file

1.4.1

1 file

1.4

1 file

1.3.1

1 file

1.3

1 file

1.2.1

1 file

1.2

1 file

1.1.1

1 file

1.1

1 file

1.0

1 file

0.6

1 file

0.5.1

1 file

0.5

1 file

0.4.1

1 file

0.4

1 file

0.3.6

1 file

0.3.5

1 file

0.3.4

1 file

0.3.3

1 file

0.3.2

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page