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)
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.3.6.tar.gz
(5.0 kB
view details)
File details
Details for the file rstcheck-0.3.6.tar.gz.
File metadata
- Download URL: rstcheck-0.3.6.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a170db248e66f9b817f418c6275d51e7ef81ff2ff4757a6944f5d669604c789f |
|
| MD5 | 413d393b0f5c74cd18853dc9597e68a1 |
|
| BLAKE2b-256 | 051287ddf0aa5475b1c2b29a4ed409249f27327c44d62bce6311eb3465ffd5f7 |
