付録AreStructuredTextリファレンス

本書で紹介したものを中心に、よく用いられるreST記法をリストアップしました。

それぞれの記法には、カテゴリを併記しています。カテゴリには以下の種類があります。

表A-2: 本リファレンスにおける記法のカテゴリ

カテゴリ

概要

Docutils

このカテゴリの記法は、Docutilsが提供しています。 DocutilsはreSTの標準規格を提供しています。 詳細はDocutilsの公式リファレンス 1 を参照してください。

Sphinx

このカテゴリの記法は、Sphinxが独自に提供しています。 詳細はSphinxの公式リファレンス 2 を参照してください。

インライン

ビルドするとインライン要素として出力されます。 インライン要素はブロック要素の内容として用いられる要素で、文章の一部として扱われます。

ブロック

ビルドするとブロック要素として出力されます。 ブロック要素は行単位で扱われる要素で、インライン要素の中には置けません。

構文

reSTとして解釈できる書き方です。 ここでは、directiveとrole以外の書き方の場合に 構文 と表示しています。

directive

ディレクティブは、対象のコンテンツに独自の解釈を行います。 ディレクティブの構文は「 .. ディレクティブ名:: 」というディレクティブ宣言と、 引数、オプションそしてコンテンツから構成されます。 処理結果はディレクティブによって異なります。

role

ロールは、対象のテキストに装飾、関連付け、リンクといった処理を行います。 通常、テキストそのものはそのまま表示されます。 ロールの構文は「 :ロール:`対象テキスト` ...