Checks syntax of reStructuredText and code blocks nested within it.
Project description
Checks syntax of reStructuredText and code blocks nested within it.
Installation
From pip:
$ pip install --upgrade rstcheck
Supported languages in code blocks
Bash
C (C99)
C++ (C++11)
JSON
Python
reStructuredText
Examples
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
With bad syntax in the reStructuredText document itself:
====
Test
===$ rstcheck bad_rst.rst bad_rst.rst:1: (SEVERE/4) Title overline & underline mismatch.
Options
usage: rstcheck [-h] [--report level] [--ignore language] files [files ...]
Checks code blocks in reStructuredText.
positional arguments:
files files to check
optional arguments:
-h, --help show this help message and exit
--report level report system messages at or higher than level; 1 info, 2
warning, 3 error, 4 severe, 5 none (default: 1)
--ignore language comma-separated list of languages to ignore
Usage in Vim
To check reStructuredText in Vim using Syntastic:
let g:syntastic_rst_checkers = ['rstcheck']Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rstcheck-1.0.tar.gz
(6.6 kB
view details)
File details
Details for the file rstcheck-1.0.tar.gz.
File metadata
- Download URL: rstcheck-1.0.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3574720b2bcf6bc3358800b051858b27c4aec1a953efe5c5066a5b847822a72a |
|
| MD5 | fe0301ad8cf7e67bce280a8ea54fd2fa |
|
| BLAKE2b-256 | 1eb13240a0a1ee9086480872ec6cfc7bc80056655532d1106a72fad44bc45037 |
