Skip to content

rstcheck/rstcheck-core

Repository files navigation

rstcheck-core

General

License Semantic Versioning - 2.0.0

---------------------------------------------------------------------------------------------+

Read the Docs - Build Status (latest)

CI 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

Library for checking syntax of reStructuredText and code blocks nested within it.

See the full documentation at read-the-docs

Installation

From pip

$ pip install rstcheck_core

To use pyproject.toml for configuration:

$ pip install rstcheck_core[toml]

To add sphinx support:

$ pip install rstcheck_core[sphinx]

To add YAML checking support:

$ pip install rstcheck_core[yaml]

Supported languages in code blocks

  • Bash
  • Doctest
  • C (C99)
  • C++ (C++11)
  • JSON
  • XML
  • Python
  • reStructuredText
  • YAML