JSON

Question

के लिए उपयोग करने के लिए कौन सी स्फिंक्स कोड-ब्लॉक भाषा मैं वेब सेवा दस्तावेज करने के लिए स्फिंक्स का उपयोग कर रहा हूं। मैं कोड-ब्लॉक निर्देश का उपयोग करके एक स्वरूपित जेएसओएन वेब प्रतिक्रिया दिखाना चाहता हूं, जो स्पिनक्स पाइगल्स के माध्यम से करता है, लेकिन जेएसओएन में पेंगल्स में सिंटैक्स हाइलाइटर नहीं है। आप किस भाषा का सुझाव देते हैं मैं इसके बजाय निर्दिष्ट करता हूं? एचटीएमएल? जावास्क्रिप्ट?

.. code-block:: javascript 

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

Answer 1

JSON जावास्क्रिप्ट, सादा और सरल है। वास्तव में जेएसओएन "जावास्क्रिप्ट ऑब्जेक्ट नोटेशन" के लिए खड़ा है।

Answer 2

मैं जेएसओएन पार्सिंग के लिए पेज्स जावास्क्रिप्ट का उपयोग करके खुश नहीं था। हां, जेएसओएन को जावास्क्रिप्ट लेक्सर द्वारा पार्स किया जा सकता है, लेकिन JSON मान पर लागू होने पर जावास्क्रिप्ट हाइलाइटिंग बहुत उपयोगी नहीं है। आप आमतौर पर अविभाजित पाठ का एक विशाल ब्लॉब प्राप्त करते हैं।

चूंकि मुझे कोई अच्छा समाधान नहीं मिला, इसलिए मैंने JSON lexer for pygments बनाया। मैं इसका उपयोग अब स्पिनक्स में जेएसओएन को हाइलाइट करने के लिए पीडीएफ दस्तावेज बनाया गया है। यह सही नहीं है, लेकिन परिणाम जावास्क्रिप्ट लेक्सर के मुकाबले ज्यादा उपयोगी हैं। मुझे उम्मीद है यह मदद करेगा।

Answer 3

स्फिंक्स 1.2 बी 1 और पाइगल्स 1.6 के साथ भी, मुझे कुछ भी करने के लिए .. code-block:: json प्राप्त करने के लिए add_lexer को कॉल करने की आवश्यकता थी। मैं एक विस्तार (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 का उपयोग कर रहा है जो "जेसन" नामक एक पेंगुले लेक्सर शामिल है। यह डिफ़ॉल्ट रूप से आउट-ऑफ-द-बॉक्स उपलब्ध है। उपयोग करने के लिए:

.. code-block:: json 

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