Skip to main content

Checks syntax of reStructuredText and code blocks nested within it

Project description

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

Uploaded Source

Built Distribution

rstcheck-6.2.5-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rstcheck-6.2.5.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for rstcheck-6.2.5.tar.gz
Algorithm Hash digest
SHA256 122b6d6b953fa1a09d7e7de42ac5d8938da291c6f68351ace6166bb50fc3bd6c
MD5 d2eb3d45ede32c77a1498479efcc9f68
BLAKE2b-256 20c94910e032405dbe1178bc410c45531b7bcc4f36326af167f4648f212c2409

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rstcheck-6.2.5-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for rstcheck-6.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 09af9555cf05f23651189154066d483ced25d36ebb3f01dc3a5d27524e4a5fdc
MD5 275724f1a45abe333ae2d93e90c71288
BLAKE2b-256 6bc267e0fa861f250e343c5c25de5f09800e85227241942d018a3e303d14d965

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page