JSONに使用するSphinxコードブロック言語

Question

私は、Webサービスを文書化するためにSphinxを使用しています。 SpinxがPygments経由で行うcode-blockディレクティブを使用して書式設定されたJSON Webレスポンスを表示したいが、JSONにPygmentsのシンタックスハイライターはありません。代わりに指定する言語は何ですか？ HTML？ JavaScript？

.. code-block:: javascript 

    { 
     "name": "roger", 
     "score": 100 
    } 

Answer 1

JSONはJavaScript、プレーンでシンプルです。 JSONは実際には "JavaScript Object Notation"の略です。

Answer 2

JSONを解析するためにpygments javascriptを使用していてうれしかったです。はい、JSONはJavaScriptのレクサーによって解析できますが、JavaScriptの強調表示はJSON値に適用するとあまり役に立ちません。あなたは通常、未分化のテキストの巨大な塊を取得します。

私は良い解決策を見つけることができなかったので、JSON lexer for pygmentsを作成しました。私は現在、sphinxで作成されたPDF文書のJSONを強調表示するために使用しています。完璧ではありませんが、結果はjavascriptのレクサーよりもずっと便利です。私はそれが助けて欲しい

Answer 3

スフィンクス1.2b1とPygments 1.6でも、add_lexerを呼び出して.. code-block:: jsonに何かをさせる必要がありました。私は拡張子（docs/_ext/jsonlexer.py）に以下のコードを入れてしまった：

def setup(app): 
    # enable Pygments json lexer 
    try: 
     import pygments 
     if pygments.__version__ >= '1.5': 
      # use JSON lexer included in recent versions of Pygments 
      from pygments.lexers import JsonLexer 
     else: 
      # use JSON lexer from pygments-json if installed 
      from pygson.json_lexer import JSONLexer as JsonLexer 
    except ImportError: 
     pass # not fatal if we have old (or no) Pygments and no pygments-json 
    else: 
     app.add_lexer('json', JsonLexer()) 

マイdocs/conf.pyスフィンクスが拡張を有効にするには、次のいのために：

import os 
import sys 

sys.path.insert(0, os.path.abspath('_ext')) 

# Add any Sphinx extension module names here, as strings. They can be 
# extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom 
# ones. 
extensions = ['jsonlexer'] 

Answer 4

私はスフィンクス1.4.2を使用していました「json」と呼ばれるPygmentsレクサーが含まれています。これは既定ですぐに利用できます。使用する：

.. code-block:: json 

    { 
     "key": "value", 
     "key2": "value2", 
     ... 
    }