Quel langage de bloc de code Sphinx à utiliser pour JSON

Je suis à l'aide de Sphinx du document à un service web. Je voudrais montrer un formatées en JSON web de la réponse à l'aide du code-bloc de la directive, qui Spinx via ne Pygments, mais JSON n'a pas une syntaxe surligneur dans Pygments. Quel langage me conseillez-vous de spécifier à la place? Le HTML? JavaScript?

.. code-block:: javascript

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

source d'informationauteur JayhawksFan93

  1. 12

    Je suis à l'aide de Sphinx 1.4.2 qui comprend un Pygments lexer appelé "json". Il est disponible out-of-the-box par défaut. Utilisation:

    .. code-block:: json

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

    Je n'étais pas heureux à l'aide de pygments javascript pour l'analyse JSON. Oui, JSON peut être analysé par le javascript lexer, javascript, mais la mise en évidence est pas très utile lorsqu'il est appliqué à une valeur JSON. Vous obtenez généralement un géant blob de indifférenciées texte.

    Puisque je ne pouvais pas trouver une bonne solution, j'ai créé un JSON lexer pour pygments. Je l'utilise maintenant pour la mise en évidence de JSON dans le sphinx document PDF créé. Il n'est pas parfait, mais les résultats sont beaucoup plus utiles que le javascript lexer. J'espère que cela aide.

  3. 4

    JSON JavaScript est, pure et simple. JSON en fait l'acronyme de "JavaScript Object Notation".

  4. 3

    Même avec Sphinx 1.2b1 et Pygments 1.6, j'ai besoin d'appeler add_lexer pour obtenir .. code-block:: json rien à faire. J'ai fini par mettre le fragment de code suivant dans une extension (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())

    Mon docs/conf.py pour les Sphinx a la suite de l'activation de l'extension:

    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']
  5. 0

    Il y a plusieurs pygment lexers dédié à JSON mettant en lumière fourni par défaut avec Sphinx, de sorte que vous pouvez choisir ici:

    http://pygments.org/docs/lexers/#lexers-for-data-file-format

    • pygments.lexers.les données.JsonLexer (pygment v1.5+)

      JSON structures de données.

      .. code-block:: json

    • pygments.lexers.les données.JsonLdLexer (pygment v2.0+)

      Pour JSON-LD de données liées.

      .. code-block:: json-ld

    • pygments.lexers.les données.JsonBareObjectLexer (pygment v2.2+)

      JSON structures de données (avec objet manquant entre accolades).

      .. code-block:: json-object