2013-05-06 7 views
6

sfenks kullanarak pasajlarını, ben gibi bir şey alarak piton kod parçacığı veya yakut Kod parçası bir parça gösterebilir biliyorum linux komutlarının snippet'i veya herhangi bir dille ilgili olmayan bazı konsol komutları mı? Düzgün bir şekilde sözdizimi olmasalar da umurumda değil, sadece doc'da normal metinden başka bir kod parçası olarak görünmelerini istiyorum. Örneğin.

ls -lsa . 
make file 

cevap

7

Sen kodu olarak yazılır istediğiniz metni girintili ve çift nokta ile o önce gelebilir. Örneğin:

Some body text explaining what's coming up:: 

    ls -lsa . 
    make file 

Ya da sadece çift iki nokta üst üste kullanarak uzak öncesinde herhangi bir metin olmaksızın alabilirsiniz çıkıyor. İlk durumda, bir kolon işlenirken, bu durumda sadece kod işlenir.

:: 
    mkdir test 
    cd !$ 

Sonra komutlar seçtiğiniz stil sayfaları bağlı bir sabit genişlikte yazı çıkıp, ve olacaktır, (yeşil arka plan ile vurgulanır, varsayılan olarak) ve ayrıca vurgulamıştır.

Ayrıca, backticks ile satır içi vurgulama yapabilirsiniz, örn. `ls -lsa .`.

.. code-block:: bash 

    $ ls -lsa . 
    $ make file 

Vurgulama Muhtemelen her zaman işe yaramaz, ama en azından eğer ona bir şans vermek: Linux konsol için

12

Eğer bash veya sh kullanabilirsiniz emreder.

.. highlight:: sh 
10
.. code-block:: console 

interaktif oturumlar içindir: Eğer çift iki nokta üst üste ile @Bonlenfum yolu kullanırsanız

Ayrıca dosyanın başında vurgulayarak varsayılan ayarlayabilirsiniz. Bash ya da Sh benim için çalışmadı.

+0

açıklanır olan bir konsol/terminali, bir komut olduğundan, bu, bash' ya da 'sh' 'daha fazla tercih edilir (http://build-me-the-docs-please.readthedocs.org/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html#pygments-lexers itibaren). Uzun çizgileri iyi idare etmemesine dikkat edin. –

İlgili konular