如何使用 sphinx 删除 reStructuredText 中代码块周围的框

Question

我正在使用重组文本来记录某些内容。要使用指令 "code-block"，代码似乎总是包含在生成的文档中的一个框中。例如，

     .. code-block:: C++
        :linenos:
        :emphasize-lines: 2

        void readIntegerFile(const string& fileName, vector<int>& dest)
            throw(invalid_argument, runtime_error)
        {
            // some code ...
        }

C++ 代码总是装箱在生成的 PDF 文件中。我想知道是否有一个旋钮可以关闭盒子。我用谷歌搜索，找不到它。事实上，我什至找不到 code-block

的完整旋钮列表

谢谢

Answer 1

该框似乎是硬编码的，但您可以通过将此命令添加到 latex_elements['preamble'] 在 conf.py 文件中：

\definecolor{VerbatimBorderColor}{rgb}{1,1,1}

如果你没有纯白色背景，这将不会很好地工作。

Answer 2

将以下代码添加到您的 conf.py 文件

latex_elements = {
    'sphinxsetup': 'verbatimwithframe=false',
}

无论您的背景颜色是什么，这都有效

如何使用 sphinx 删除 reStructuredText 中代码块周围的框

How to remove the box around the code-block in reStructuredText with sphinx

restructuredtext

python-sphinx