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

Question

我有一个 RST 文件，我不需要任何语法高亮显示。它在文件顶部包含多个文字块和一个 highlight 指令，以尝试禁用语法高亮:

.. 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 语法突出显示。 .突出显示诸如“无”和“列表”之类的词。

如何有选择地禁用此 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