选择性地禁用 readthedocs 语法高亮

【问题标题】：Selectively disable readthedocs syntax highlighting选择性地禁用 readthedocs 语法高亮
【发布时间】：2017-11-06 16:42:42
【问题描述】：

我有一个 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 语法突出显示。突出显示“无”和“列表”等词。

如何选择性地禁用此 RST 文件中的语法高亮显示，同时将语法高亮显示保留在其他位置？

【问题讨论】：

标签： python-sphinx restructuredtext read-the-docs

【解决方案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

【讨论】：