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）標題上線和下劃線不匹配。