有选择地禁用readthedocs语法高亮显示

时间:2017-06-05 20:10:02

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

我有一个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文件中有选择地禁用语法突出显示,同时在其他位置保持语法高亮?

1 个答案:

答案 0 :(得分:6)

您可以直接使用两个突出显示指令.. highlight:: none,紧接着是::。前者被后者覆盖,后者使用后一种语言的语法高亮。

::使用default language configured for syntax highlighting,通常是Python3。

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

我只使用一个指令,然后是我要强调的代码。

就使用哪种语法而言,您可以使用text,它只是普通的旧文本,none,或者构成不属于Pygments词法分析器的东西,例如{{1} }。有关详细信息,请参阅Showing code examples

moosehair

或者,如果您使用.. code-block:: text Plain old text conf.py进行了设置,则可以使用highlight_language = 'none'

::