python-sphinx: wie um zu zeigen, linux-Befehl code-snippets

Mit sphinx, ich weiß, Sie können zeigen, ein Stück python-code-snippet oder ruby-code-snippet ein, indem Sie mit so etwas wie:

.. code-block:: ruby.
  ${your ruby code goes here}

Wie kann ich ein code-snippet linux-Befehle oder nur einige Konsolen-Befehle, die nicht im Zusammenhang mit Sprachen? I don ' T care, wenn Sie nicht korrekt hervorgehoben syntax klug, will ich nur Ihnen zu zeigen, bis in den doc-als ein Stück code anders als ein normaler text. zB.

ls -lsa . 
make file
InformationsquelleAutor Shengjie | 2013-05-06
  1. 14

    Können Sie Gedankenstrich der text, den Sie geschrieben werden als code, und vorausgehen, die mit einem doppelten Doppelpunkt. Zum Beispiel:

    Some body text explaining what's coming up::

    ls -lsa .
    make file

    Oder es stellt sich auch heraus, Sie können sich ohne text vor, nur mit dem Doppel-Doppelpunkt. Im ersten Fall wird ein Doppelpunkt gerendert wird, während für diesen Fall nur den code gerendert wird.

    ::
    mkdir test
    cd !$

    Dann die Befehle kommen in einem Zeichensatz mit fester Breite, und je nach style-sheets, die Sie gewählt haben, hervorgehoben werden (standardmäßig markiert mit dem grünen hintergrund).

    Können Sie auch als inline-highlight mit backticks, z.B. `ls -lsa .`.

    • Als wswld Hinweise unten, dieser leichte Ansatz ist nicht ratsam, es sei denn, auch gepaart mit einem parser-Richtlinie ähnlich .. highlight:: console an der Spitze Ihres ReST-Dokument. Dabei informiert die ReST-parser (z.B. die Sphinx) der Standard-Sprache verwendet werden, die für alle code-Blöcke fehlt eine explizite Sprache. In diesem Fall sollte console – die "Sprache" in Verbindung mit der Bash-shell-Einzeiler ausgeführt werden soll interaktiv. Das heißt, explizit ist besser als implizit.
    InformationsquelleAutor Bonlenfum
  2. 26
    .. code-block:: console

    ist gedacht für interaktive sessions. Bash oder sh hat bei mir nicht funktioniert.

    ( aus http://build-me-the-docs-please.readthedocs.org/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html#pygments-lexers )

    • Diese ist bevorzugt über bash oder sh, da es eine Konsole/terminal, das hier beschrieben wird, nicht ein Skript. Seien Sie sich aber bewusst, dass es nicht mit langen Linien gut.
    InformationsquelleAutor Marco Mariani
  3. 16

    Für die Linux Konsole Befehle, die Sie verwenden könnten bash oder sh:

    .. code-block:: bash

   $ ls -lsa .
   $ make file

    Hervorheben würde nicht wahrscheinlich arbeiten die ganze Zeit richtig, aber mindestens Sie geben ihm eine chance.

    Können Sie auch die Standard-Hervorhebung in den Anfang der Datei, wenn Sie die @Bonlenfum Weise mit Doppel-Doppelpunkte:

    .. highlight:: sh
    InformationsquelleAutor wswld
Schreibe einen Kommentar