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のウェブサイト上に構築された場合、RSTファイル内のリテラルブロック内に望ましくないPython構文の強調表示があり、.. highlight:: noneが含まれています。 「なし」や「リスト」のような言葉が強調表示されます。

このRSTファイルで構文ハイライトを選択的に無効にするにはどうすればよいですか？

Answer 1

直接的に2つのハイライト指示を使用します。.. highlight:: noneに続いて、すぐに::が続きます。前者は、後者の言語の構文強調を適用する後者によって上書きされます。

::は、通常はPython3のdefault language configured for syntax highlightingを使用します。

2つの指令を連続して使用しません。

1つのディレクティブだけを使用し、次にハイライトしたいコードを使用します。

どの構文を使用するかは、textという単純な古いテキストのnoneを使用するか、moosehairのようなPygmentsレクサーのいずれかではないものを作成することができます。詳細については、Showing code examplesを参照してください。

.. code-block:: text 

    Plain old text 

それとも、あなたのconf.pyに設定した場合、highlight_language = 'none'、あなたは::を使用することができます。

:: 

    Plain old text