整形済みテキストを書く

ソースファイルなどを整形済みテキストとして記述したい場合、セミコロン(”:”)を二つ付けることで、コードブロックがあります。コロンは前の段落の末尾に付けることもできます。また、ブロックの前後には空行を入れてください。

::

このドキュメントには間違いがたくさんありますのでご指摘
くださると大変ありがたく思います。

ソースコードを入れる場合には、言語名を指定することで、その言語に適した装飾が行われます。この装飾にはPygmentsというライブラリを利用しており、かなり多くの言語や形式に装飾を施せます。

.. code-block:: python

   import this

.. code-block:: xml

   <test>
     <code>ここはコード</code>
     <block is="true"/>
     <code>ブロックです</code>
   </test>

適用例

本ドキュメントはフィクションです。登場する人物、
企業名は架空のものです。

pythonのコードブロックの例

import this

xmlのコードブロックの例

<test>
  <code>ここはコード</code>
  <block is="true"/>
  <code>ブロックです</code>
</test>