はやわかり reStructuredText

タイトル

サブタイトル

タイトル類は非英数の7ビットアスキー文字で 下線（または上下線）を引きます。 次の文字の使用が推奨されます。 = - ` : ' " ~ ^ _ * + # < > 。 上下線は、タイトルのテキストと同じか長くします。

最上部に書かれた、同し線種での繰り返しの無い タイトル（およびサブタイトル）は、 文書全体のタイトル（およびサブタイトル）として 取り扱われます。

ここが段落です。

段落は、左の端を
そろえて記述します。通常、
空行で区切られます。

ここが段落です。

段落は、左の端を そろえて記述します。通常、 空行で区切られます。

- アイテム 1 です
- アイテム 2 です

- リスト記号は"-" および "*", "+" が使用できます。
  複数行にわたる場合は、記号と空白文字の後に、
  左端をそろえて記述します。

最初のアイテムの前および最後のアイテムの後には空行が
必要です。アイテム間の空行は任意です。

• アイテム 1 です
• アイテム 2 です
• リスト記号は"-" および "*", "+" が使用できます。 複数行にわたる場合は、記号と空白文字の後に、 左端をそろえて記述します。

最初のアイテムの前および最後のアイテムの後には空行が 必要です。アイテム間の空行は任意です。

3. はじめのアイテム
4. 次のアイテム
5. 番号は、アラビア数字、単一の英字、もしくは
   ローマ数字が使用できます。
6. アイテムは、連続した数で番号付けするべきです。
   ただし、必ずしも１からはじめる必要はありません
   （フォーマッタがによっては任意の番号からの
   開始を適切に扱えないこともあります。）

3. はじめのアイテム
4. 次のアイテム
5. 番号は、アラビア数字、単一の英字、もしくはローマ数字 が使用できます。
6. アイテムは、連続した数で番号付けするべきです。ただし、 必ずしも１からはじめる必要はありません （フォーマッタがによっては任意の番号からの 開始を適切に扱えないこともあります。）

それは何？

定義リストは、用語とその定義を示します。

どのようにして？

「用語」は 1 行のテキストです。 「定義」は、段落などのボディ要素で、 複数の段落を記述することもできます。 用語との間に空行を入れないで、右側に インデントさせます。

    (および多くの親切な方々)

:バージョン: 1.0 of 2001/08/08
:献呈: 我が父へ

-a            command-line option "a"
-b file       options can have arguments
              and long descriptions
--long        options can be long also
--input=file  long options can also have
              arguments
/V            DOS/VMS-style options too

2つのコロンだけの段落は、後続のインデントされた、 もしくはクオートされたテキストが 整形済みブロックであることを示します。

  空白文字、改行、空行および
  （*this* や \this などの）すべての
  マークアップはそのまま表示されます。
  
  2つのコロンだけの段落は、削除
  されます。
            

:: を段落の最後に記述することも できます。直前に空白文字がある場合は :: は削除されます。直前が 通常の文字である場合は、コロン1つに変換されます。 例:

  
  この形式はとても便利です。
            

整形済みブロックは、テキストが元のインデントの 深さに戻るまで有効となります。 つまり、以下のようにも記述できます。

      ここからはじめ
    ここへ続き
  ここで終わる

各行ごとにクオートされたブロックは、特に明示する こと無しに、整形済みブロックとして扱われます。

  > メールの引用や
  > Haskell言語のプログラムに有効です

    インデントした段落を書くだけです。

        入れ子にもできます。

インデントした段落を書くだけです。

入れ子にもできます。

Doctest blocks are interactive
Python sessions. They begin with
"``>>>``" and end with a blank line.

>>> print "This is a doctest block."
This is a doctest block.

Doctest blocks are interactive Python sessions. They begin with ">>>" and end with a blank line.

>>> print "This is a doctest block."
This is a doctest block.

グリッドテーブル

+------------+------------+-----------+
| Header 1   | Header 2   | Header 3  |
+============+============+===========+
| body row 1 | column 2   | column 3  |
+------------+------------+-----------+
| body row 2 | Cells may span columns.|
+------------+------------+-----------+
| body row 3 | Cells may  | - Cells   |
+------------+ span rows. | - contain |
| body row 4 |            | - blocks. |
+------------+------------+-----------+

グリッドテーブル

シンプルテーブル

=====  =====  ======
   Inputs     Output
------------  ------
  A      B    A or B
=====  =====  ======
False  False  False
True   False  True
False  True   True
True   True   True
=====  =====  ======

シンプルテーブル

区切り線のマーカは、記号文字4つ以上からなる
水平ラインです。

------------

区切り線は、セクションの最初や最後に置くべきでは
ありませんし、区切り線を連続してならべるのも
避けるべきです。

区切り線のマーカは、記号文字4つ以上からなる 水平ラインです。

区切り線は、セクションの最初や最後に置くべきでは ありませんし、区切り線を連続してならべるのも 避けるべきです。

.. [5] 番号つき脚注。
   ] の後にはコロンを付けないこと。

.. [#] 第一番目
.. [#] 第二番目

番号付用のラベルを記述できます。例、
[#fourth]_ および [#third]_ 。

.. [#third] 別名 third_

.. [#fourth] 別名 fourth_

番号付用のラベルを記述できます。例、 ⁴ および ³ 。

.. [*] 第一番目の記号つき脚注
.. [*] これは2番目

.. [CIT2002] とある出典
   (たとえば雑誌など)

出典のラベルは、英数字、アンダーライン、ハイフン
およびピリオドで構成されます。
大小文字は区別されません。

出典参照が [this]_ と書かれた場合、
this_ とすれば出典を参照できます。

.. [this] こちら

出典のラベルは、英数字、アンダーライン、ハイフンおよびピリオド で構成されます。大小文字は区別されません。

出典参照が [this] と書かれた場合、 this とすれば出典を参照できます。

.. _Python: http://www.python.org/

.. _example:

ここ が、内部相互参照の例のターゲットになります。

.. _Python: http://www.python.org/

__ Python_

Python は、 私のお気に入りのプログラム言語 です。

暗黙ターゲットの例、 タイトルもターゲット 。

.. image:: images/ball1.gif

.. |biohazard| image:: biohazard.png

シンボルは、 医療廃棄物を収めたコンテナに表示されるマークです。

ですので、このブロックはインデント されていますが、表示されます。