有选择地禁用 readthedocs 语法突出显示

Question

我有一个 RST 文件，我不想对其进行任何语法突出显示。它在文件顶部包含多个文字块和一个高亮指令，以尝试禁用语法高亮：

.. highlight:: none

::

  Text that happens to contain words like list, None, etc.

::

  Another literal block with words like list, None, etc.

项目中的其他一些 RST 文件使用语法高亮显示指令，如下所示：

.. highlight:: bash

当我在我的工作站上使用 sphinx 构建文档时，sphinx 正确地突出显示启用的语法并禁用禁用语法突出显示的语法。但是，当构建在 readthedocs 网站上时，在包含 .. highlight:: none 的 RST 文件的文字块中存在不需要的 Python 语法突出显示。 "None" 和 "list" 之类的词会突出显示。

如何有选择地禁用此 RST 文件中的语法突出显示，同时在其他地方保留语法突出显示？

Answer 1

您直接连续使用了两个突出显示指令，.. highlight:: none 紧接着是 ::。前者被后者覆盖，后者应用后一种语言的语法突出显示。

::使用default language configured for syntax highlighting，通常是Python3.

我不会连续使用两个指令。

我只会使用一个指令，然后是我要突出显示的代码。

至于使用哪种语法，你可以使用 text 这只是普通的旧文本，none，或者编造一些不是 Pygments 词法分析器的东西，比如 moosehair。有关详细信息，请参阅 Showing code examples。

.. code-block:: text

    Plain old text

或者如果您在 conf.py、highlight_language = 'none' 中设置，您可以使用 :::

::

    Plain old text

有选择地禁用 readthedocs 语法突出显示

Selectively disable readthedocs syntax highlighting

restructuredtext

python-sphinx

read-the-docs