2016-01-12 7 views
6

Qual è il punto dell'opzione Sphinx highlight_language config se code-block :: non ha un argomento facoltativo?Qual è il punto dell'opzione Sphinx highlight_language config se code-block :: non ha un argomento facoltativo?

Dice che imposta il valore predefinito hightlight_language, ma se ogni volta che si specifica il codice è necessario specificare la lingua, perché è necessaria l'opzione di configurazione?

Sto facendo qualcosa di sbagliato?

Modifica: Dai log quando rimuovo l'argomento per il codeblock.

C:\c\Sponge\SpongeDocs\source\plugin\scheduler.rst:25: ERROR: Error in "code-block" directive: 
1 argument(s) required, 0 supplied. 

.. code-block:: 

    taskBuilder.execute(new Runnable() { 
     public void run() { 
      logger.info("Yay! Schedulers!"); 
     } 
    }); 
+0

E 'possibile impostare una lingua sconosciuta? –

risposta

4

La documentazione è un po 'vaga qui. Infatti la direttiva ..code-block:: dovrebbe essere utilizzata solo se si desidera specificare esplicitamente la lingua per qualche motivo. Per impostazione predefinita è necessario utilizzare un semplice blocco :::

Examples of Python source code or interactive sessions are represented using standard reST literal blocks. They are started by a :: at the end of the preceding paragraph and delimited by indentation.

(Fonte: http://www.sphinx-doc.org/en/stable/markup/code.html)

Si sarà simile a questa:

:: 

    var hello = "Hello, World!"; 
    console.log(hello); 
1

Quando si utilizza la direttiva code-block::, specificando la lingua è opzionale.

Come spiegato nello documentation, l'evidenziazione della lingua predefinita è per python. Con l'impostazione di highlight_language, puoi modificarlo, ad es. per evidenziare il codice c quando si utilizza un code-block:: senza specificare una lingua.

+0

C: \ c \ Sponge \ SpongeDocs \ source \ plugin \ scheduler.rst: 25: ERRORE: errore nella direttiva "code-block": 1 argomento (i) richiesto, 0 fornito. .. code-block :: taskBuilder.execute (new Runnable() { public void run() { logger.info ("Yay! Schedulatori!");} }); –

+0

su quale versione della Sfinge siete e cosa state esattamente costruendo? –

+0

Un fork locale di https://github.com/SpongePowered/SpongeDocs/ con highlight_language = 'java' aggiunto al conf. "Creato utilizzando Sphinx 1.3.3." –