web-dev-qa-db-ja.com

python-sphinx：Linuxコマンドコードスニペットを表示する方法

スフィンクスを使用すると、次のようなものを使用して、pythonコードスニペットまたはRubyコードスニペットを表示できます。

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

Linuxコマンドのコードスニペットまたはどの言語にも関係のないいくつかのコンソールコマンドを表示するにはどうすればよいですか？構文的に適切に強調表示されていなくてもかまいません。通常のテキスト以外のコードとしてドキュメントに表示するだけです。例えば。

ls -lsa . 
make file
python-sphinx
18
Shengjie

コードとして記述したいテキストをインデントし、その前に二重コロンを付けることができます。例えば：

Some body text explaining what's coming up::

    ls -lsa .
    make file

または、二重コロンを使用するだけで、以前はテキストなしで逃げることができることもわかりました。最初のケースでは、1つのコロンがレンダリングされますが、この場合、コードのみがレンダリングされます。

::
    mkdir test
    cd !$

次に、コマンドは固定幅フォントで出力され、選択したスタイルシートに応じて、同様に強調表示されます（デフォルトでは、緑色の背景で強調表示されます）。

バックティックでインラインハイライトすることもできます。 `ls -lsa .`。

16
Bonlenfum
.. code-block:: console

インタラクティブセッション用です。 Bashまたはshは私には機能しませんでした。

（ http://build-me-the-docs-please.readthedocs.org/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html#pygments-lexers から）

28
Marco Mariani

Linuxコンソールコマンドの場合、bashまたはshを使用できます。

.. code-block:: bash

   $ ls -lsa .
   $ make file

ハイライトは常に正しく機能するとは限りませんが、少なくともチャンスを与えてください。

二重コロンを使用して@Bonlenfumを使用する場合は、ファイルの先頭にデフォルトの強調表示を設定することもできます。

.. highlight:: sh
19
wswld