rstcheck

RSTCHECK

一般的
CI
PYPI
github

检查嵌套在其中的重组文本和代码块的语法。

请参阅“阅读”中的完整文档

内容

• 安装
• 代码块中支持的语言
• 例子

安装

来自pip

$ pip install rstcheck

使用pyproject.toml进行配置：

 $ pip安装rstCheck [toml]

添加狮身人面像：

 $ pip安装rstCheck [sphinx]

代码块中支持的语言

• bash
• 医生
• C（C99）
• C ++（C ++ 11）
• JSON
• XML
• Python
• 重组文本

例子

带有不良的python语法：

 ====
Test
====

.. code :: python

    print (

 $ rstCheck bad_python.rst
bad_python.rst：7 ：（错误/3）（Python）解析时出乎意料的EOF

使用不良的C ++语法：

 ====
Test
====

.. code :: cpp

    int main()
    {
        return x;
    }

 $ rstCheck bad_cpp.rst
bad_cpp.rst：9 ：（错误/3）（cpp）错误：'x'在此范围中未声明

重组文档本身中使用不良语法：

 ====
Test
===

 $ rstCheck bad_rst.rst
bad_rst.rst：1 ：（严重/4）标题上线和下划线不匹配。