Checks code blocks in reStructuredText.
Project description
Checks code blocks in reStructuredText.
This is in addition to the usual docutils reStructuredText syntax check itself.
Installation
From pip:
$ pip install --upgrade rstcheck
Supported languages in code blocks
Bash
C (C99)
C++ (C++11)
JSON
Python
reStructuredText
Example
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
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-0.4.1.tar.gz
(5.2 kB
view details)
File details
Details for the file rstcheck-0.4.1.tar.gz.
File metadata
- Download URL: rstcheck-0.4.1.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 075de3b091588e4d9d71b0286847b8ba3e8d3b055c03f43fbf3320a7a2a33733 |
|
| MD5 | 454f6877f120f1cd91678f8dcba2f745 |
|
| BLAKE2b-256 | 25f526a5e165a45ba224bddbd1d63d5c3ceb2659a667a4e8017be68fc68ec5a7 |
