reStructuredTextディレクティブ仕様の要約 (reStructuredText Directives)¶

原文:	reStructuredText Directives(rev.7747)
原著者:	David Goodger
著者:	helloaworld.com
連絡先:	http://helloaworld.com
Revision:	0.0
Date:	2014/11/1
Copyright:	クリエイティブコモンズ　表示-非営利-継承

reStructuredTextディレクティブ仕様の要約 (reStructuredText Directives)

警告 ¶

仕様 ¶

Directive Types:
	attention caution danger error hint important note tip warning admonition
Directive Arguments:
	None.
Directive Options:
	共通オプション:
Directive Content:
	Interpreted as body elements.

使用例

警告

Beware killer rabbits!

.. warning::
       Beware killer rabbits!

一般的な警告 ¶

Directive Arguments:
Directive Type:	“admonition”
	タイトルとして一つ必要
Directive Options:
	共通オプション
Directive Content:
	本文の要素として解釈される。

サンプル

one point advice

ワンポイントアドバイスの内容

コード:

.. admonition:: one point advice
   :name: testdesu

   ワンポイントアドバイスの内容

画像 ¶

“image”と”figure”、二つのディレクティブがあります。

Image…画像を挿入する ¶

Directive Arguments:
Directive Type:	“image”
	画像のURIが一つ必須
Directive Options:
	alt : 画像の説明文。画像が表示されない場合や、音声読み上げに利用。 hegith : 画像の縦幅をピクセル数で指定。”scale”オプションと組み合わせることが可能に。 width : 画像の横幅。パーセンテージでも指定可能。以下、height同様。 scale : 縦横同比率で画像を拡大します。デフォルトは”100%”で、%の付記は任意。 align : “top”, “middle”, “bottom”, “left”, “center”, or “right” target : uriか参照名を指定して、ハイパーリンクできます。及び一般的な共通オプション。
Directive Content:
	無し

コードの例:

.. image:: picture.jpeg
   :height: 100px
   :width: 200 px
   :scale: 50 %
   :alt: alternate text
   :align: right

Makes the image into a hyperlink reference ("clickable").  The
option argument may be a URI (relative or absolute), or a
`reference name`_ with underscore suffix (e.g. ```a name`_``).

and the common options :class: and :name:.

Figure…画像を挿入する(キャプション付き)¶

Directive Arguments:
Directive Type:	“figure”
	画像のURIが一つ必須
Directive Options:
	align : left”, “center”, “right”で、横方向の配置を設定。 figwidth : “image”, length, or percentage of current line width figclass : figure要素のclasses属性を指定可能。classディレクティブを参照。
Directive Content:
	任意のキャプション

+---------------------------+
|        figure             |
|                           |
|<------ figwidth --------->|
|                           |
|  +---------------------+  |
|  |     image           |  |
|  |                     |  |
|  |<--- width --------->|  |
|  +---------------------+  |
|                           |
|The figure's caption should|
|wrap at this width.        |
+---------------------------+

本文の要素 ¶

Topic…文章を罫線で囲む ¶

Directive Arguments:
Directive Type:	“topic”
	タイトルとして一つ必要
Directive Options:
	共通オプション
Directive Content:
	トピックの本文として解釈されます

Topicは、文章を罫線で囲むことが出来ます。タイトルを設定することが出来る特徴があります。

サンプル

トピックのタイトル

トピックの本文がここに記載されます。

コード:

.. topic:: トピックのタイトル

        トピックの本文が
        ここに記載されます。

Sidebar…ページのサイドに罫線で囲まれた文章を作成 ¶

Directive Arguments:
Directive Type:	“sidebar”
	タイトルとして一つ必要
Directive Options:
	subtitle : 任意で、サブタイトルを指定できます。共通のオプション
Directive Content:
	本文として解釈されます。

サンプル

この部分はこのように回り込むような形で、
表示されます。

コード:

.. sidebar:: 再度バーのタイトル
   :subtitle: サブタイトル

   ここが本文です。

| この部分はこのように表示されます。
| 折り重なります。
|
|
|
|

Line-block…任意の場所で改行を行う。¶

このディレクティブは廃止予定のため、本ドキュメントでは省略します。行ブロックを利用してください。行ブロックは、行頭に”|”を配置する構文です。

parsed-literal…インラインマークアップが解釈されるリテラルブロック ¶

Directive Arguments:
Directive Type:	“parsed-literal”
	無し
Directive Options:
	共通オプション
Directive Content:
	本文

リテラルブロックと異なって、インラインマークアップが解釈されます。

サンプル

インラインマークアップが 解釈されます。

.. parsed-literal::

    インラインマークアップが **解釈されます。**

Code…ソースコードなどのハイライトを行う ¶

Directive Arguments:
Directive Type:	“code”
	任意で、言語を指定できます。
Directive Options:
	number-lines : 開始する行の番号を指定できます。デフォルトは1。共通のオプション
Directive Content:
	本文

コードの言語が解釈されてハイライトなどが行われます。

サンプル

5 def my_function():
6     "just a test"
7     print 8/2

コード:

.. code:: python
  :number-lines: 5

  def my_function():
      "just a test"
      print 8/2

ヒント

sphinxでもcode-blockディレクティブ等拡張が行われています。sphinxでは、code-blockを利用した方が良いでしょう。

Math…latex形式の数式構文を利用する。¶

Directive Arguments:
Directive Type:	“math”
	任意で、一つの見せ掛けの本文を指定可能。
Directive Options:
	共通オプション
Directive Content:
	本文。数式などが解釈されます。

latex形式の数式構文が使用できます。 htmlに変換するには、その他設定が必要です。

ヒント

sphinxの拡張機能を利用できます。sphinx利用の場合は、sphinxのドキュメントを参照してください。

コード:

.. math::
  α_t(i) = P(O_1, O_2, … O_t, q_t = S_i λ)

Rubric…目次に影響のない、見出しを作る。¶

Doctree Element:
Directive Type:	“rubric”
	rubric
Directive Arguments:
	1, required (rubric text).
Directive Options:
	共通オプション
Directive Content:
	None.

目次等に影響のない、見出しの様なものを作れます。

サンプル

たたｄふぁｓｊｋｌｆだｓｊｋ

.. rubric:: たたｄふぁｓｊｋｌｆだｓｊｋ

Epigraph…題辞を記載する。¶

Directive Arguments:
Directive Type:	“epigraph”
	無し
Directive Options:
	無し
Directive Content:
	本文

題辞を記載できます。

サンプル

No matter where you go, there you are.

—Buckaroo Banzai

.. epigraph::

        No matter where you go, there you are.

        -- Buckaroo Banzai

Highlights…epigraphと類似した動作 ¶

Directive Arguments:
Directive Type:	“highlights”
	無し
Directive Options:
	無し
Directive Content:
	本文

epigraphと類似した動作になります。

Pull-Quote…epigraphと類似した動作 ¶

Directive Arguments:
Directive Type:	“pull-quote”
	無し
Directive Options:
	無し
Directive Content:
	本文

epigraphと類似した動作になります。

Compound…レベルや段落を変更せずに、ディレクティブオプションの共通オプションを設定する ¶

Directive Arguments:
Directive Type:	“compound”
	None.
Directive Options:
	共通オプション
Directive Content:
	Interpreted as body elements.

同じレベルの段落で、ディレクティブオプションの共通オプションを適応できます。 htmlでは問題が起こる可能性があるので、後述のContainerを使ってください。

Container…レベルや段落を変更せずに、ディレクティブオプションの共通オプションを設定する ¶

Directive Arguments:
Directive Type:	“container”
	任意でclass namesを指定可能
Directive Options:
	name:
Directive Content:
	本文

classesを引数として受け取れます。同じレベルの段落で、共通オプションのclassesやnameが設定できます。、

コード例:

.. container:: custom

   This paragraph might be rendered in a custom way.

表 ¶

表は、reStructuredText構文が提供しています。ただ、タイトルをつけたり、csvデータをサポートできません。これをディレクティブでサポートできます。

Table…表を作成する。¶

Directive Arguments:
Directive Type:	“table”
	任意で、表のタイトル
Directive Options:
	共通オプション
Directive Content:
	reStructuredText形式の表

サンプル

Truth table for “not”
A	not A
False	True
True	False

コード:

.. table:: Truth table for "not"

  =====  =====
    A    not A
  =====  =====
  False  True
  True   False
  =====  =====

Csv-table…Csv形式を利用して表を作成する。¶

Directive Arguments:
Directive Type:	“csv-table”
	任意で、表のタイトルを指定可能。
Directive Options:
	width : コンマ若しくはスペースで区切って、列の幅を指定。デフォルトは全ての列は等幅です。(整数 [, 整数...] ) header-rows : 行見出しの数(整数) stub-colums : 列見出しの数(整数) header : csvデータと独立して行見出しを与えることが出来ます。(csvデータ) file : csvデータのパス。(文字列。但し改行は無視されます) url : インターネットURL。(文字列。但し空白は無視されます) encoding : csvファイル若しくはURLのエンコーディング(エンコーディングを示す文字列) delim : csvデータのセパレータを指定できます。(char \| “tab” \| “space”) quote : csvデータのクォーテーションの文字を指定できます(char) keepspace : 区切り文字に続く空白を無視しない。デフォルトは無視されます(flag) escape : デリミタやクォーテーションをエスケープする文字。基本的に、クォーテーションされていないデリミタのエスケープで使われます。クォーテーション内のデリミタ文字は無視されます。デフォルト動作で、クォーテーションをエスケープする際はクォーテーション文字を二つ連続して使用すればよいです。(char) 共通のオプション
Directive Content:
	csv形式の表

このディレクティブは、csv形式で表を記述できます。またcsvファイルをインポートして、表にすることも出来ます。

サンプル

Frozen Delights!
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

コード:

.. csv-table:: Frozen Delights!
       :header: "Treat", "Quantity", "Description"
       :widths: 15, 10, 30
       :stub-columns: 2


       "Albatross", 2.99, "On a stick!"
       "Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be
       crunchy, now would it?"
       "Gannet Ripple", 1.99, "On a stick!"

警告

csv-tableディレクティブは、fileとurlのオプションに潜在的なセキュリティーホールがあります。”file_insertion_enabled”のランタイム設定を無効化すれば、回避できます。

List-table…リスト形式（箇条書きの様な）で表を作成する。¶

Directive Arguments:
Directive Type:	“list-table”
	任意でテーブルのタイトル一つ。
Directive Options:
	width: 列の幅の比。デフォルトは等幅です。　(整数、若しくは整数の配列) header-rows: 行見出しの数（整数） stub-columns: 列見出しの数（整数）共通オプション
Directive Content:
	二階層の箇条書きリスト

二階層の箇条書きリストの、二階層目の項目数はそれぞれ等しい必要があります。

サンプル

Frozen Delights!
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

コード:

.. list-table:: Frozen Delights!
     :widths: 15 10 30
     :header-rows: 1

     * - Treat
       - Quantity
       - Description
     * - Albatross
       - 2.99
       - On a stick!
     * - Crunchy Frog
       - 1.49
       - If we took the bones out, it wouldn't be
         crunchy, now would it?
     * - Gannet Ripple
       - 1.99
       - On a stick!

Document Parts ¶

Contents…目次を挿入する ¶

Directive Arguments:
Directive Type:	“contents”
	任意でタイトル一つ
Directive Options:
	depth: 目次にするセクションレベルの階層数。デフォルトは無制限です。（整数） local: ローカルな目次を生成。ディレクティブを呼び出したセクション以下のセクションを含む目次を生成します。明白なタイトルが与えられなければ、タイトルは表示されません。( flag (empty)) backlinks: 各章の見出し部分を、同見出し部分(top)へリンクする、若しくは目次の同見出し部分(entry)へリンクする。(“entry” or “top” or “none”) class: 見出し要素に”classes”の属性を与える。classディレクティブを参照。
Directive Content:
	無し。

見出しを作成する

サンプル:

ここがタイトル

reStructuredTextディレクティブ仕様の要約 (reStructuredText Directives)

コード:

.. contents:: ここがタイトル
      :depth: 2
      :backlinks: none

Sectnum,section-autonumbering…セクションに自動で番号を割り当てる ¶

Directive Arguments:
Directive Type:	“sectnum” or “section-autonumbering” (synonyms)
	無し。
Directive Options:
	depth: 番号を割り当てする階層。デフォルトは無制限です。（整数） prefix: 任意のセクション番号の接頭文字。例えば”3.a.”と与えれば、”3.a.1”等となります。番号を区切る句読点が明確に含まれていなければなりません。デフォルトは接頭文字がありません。（文字列） suffix: 接尾の文字。デフォルトは接尾の文字はありません。（文字列） start: 最初のセクション番号。接尾文字(prefix)と同時に指定することで、複数のソースのファイルで、正当なナンバリングを行えます。デフォルトは1です。
Directive Content:
	無し

警告

sphinxでは、docutilsの本ディレクティブを使用しないように呼びかけられています。

Header,footer…ページのヘッダやフッターを設定する ¶

Directive Types:
	“header” and “footer”
Directive Arguments:
	無し。
Directive Options:
	無し。
Directive Content:
	Interpreted as body elements.

警告

sphinxでは、docutilsの本ディレクティブを使用しないように呼びかけられています。

ウェブページや印刷されたページの、上部分下部分を装飾できます。案内や、注意、日付などで便利です。

コード:

.. header:: printed in 2014/3/3.

参照 ¶

Target Footnotes ¶

原文の説明が不足気味で意味の分からない直訳しかできないため、省略します。

Footnotes ¶

未実装

Citations ¶

未実装

HTML仕様 ¶

Meta…HTMLのメタタグ内のデータを設定する ¶

Directive Arguments:
Directive Type:	“meta”
	無し
Directive Options:
	原文には無しとありましたが、フィールドリストとして与えることの出来るタグを列挙します。基本的にmetaタグのname属性の中身をフィールドリストとして与えることが出来ます。以下の属性は、”attr=value”という記述形式のフィールドリストで与えることが出来ます。 http-equiv scheme lang dir
Directive Content:
	単一階層のフィールドリストを含む必要があります。

metaディレクティブは、HTMLのメタタグ(<meta></meta>)内のメタデータを記述するために使われます。サーチエンジンが抜粋や照合を行い易くする形式で、メタデータでwebページを分類することができます。

コード例:

.. meta::
   :description: The reStructuredText plaintext markup language
   :keywords: plaintext, markup language
   :description lang=en: An amusing story
   :http-equiv=Content-Type: text/html; charset=ISO-8859-1

HTMLへの変換結果:

<meta name="description"
    content="The reStructuredText plaintext markup language">
<meta name="keywords" content="plaintext, markup language">
<meta name="description" lang="en" content="An amusing story">
<meta http-equiv="Content-Type"
     content="text/html; charset=ISO-8859-1">

Imagemap ¶

未実装

置換を行うディレクティブ ¶

本章のディレクティブは、置換を定義するために利用されます。これらは、脈絡無く単独で、直に呼び出されないものがあります。 imageディレクティブのように、単独でも利用できるものもあります。

Replace…文字列の置換 ¶

Directive Arguments:
Directive Type:	“replace”
	無し。
Directive Options:
	無し。
Directive Content:
	インラインマークアップを含むことが出来る、単一の段落。

replaceディレクティブは、参照したものの置換を指示出来ます。置換内容の定義しかできません。例えば、略記や略称を展開するために利用できます。また、ネストしたインラインマークアップはサポートされていません。参照を行う唯一の方法は、置換対象の文字列を利用して行えます。

サンプルは以下

そらいけっ、かえるの歌が聞こえてくるよ♪

コード:

そらいけっ、 |かえるの歌|

.. |かえるの歌| replace:: かえるの歌が聞こえてくるよ♪
.. _かえるの歌: http://kaerugakae.ru

Unicode…文字コード番号を指定して、文字を挿入する ¶

Directive Arguments:
Directive Type:	“unicode”
	一つ以上が必要。(unicodeの文字コード、任意の文字列、コメント)
Directive Options:
	ltrim: 置換後、左側の空白を除去する(flag) rtrim: 置換後、右側の空白を除去する(flag) trim: 上記二つのオプションを有効にする(flag)
Directive Content:
	None.

”..”以降はコメントとして無視されます。また、スペースで区切られた引数は以下のように指定できます。

10進数

右記の文字に続けた16進数。 0x, x, \x, U+, u, \u

xml形式の16進数表記。 ᨫ

サンプル:

コード:

|copyr| 2005, 桃太郎交通 |TM| |---| all rights reserved.

.. |copyr| unicode:: Copyright 0xA9 .. circle c
.. |TM| unicode:: U+2122
.. |---| unicode:: &#x02014;

Date…(ドキュメントが生成された)日付を入力する ¶

Directive Arguments:
Directive Type:	“date”
	任意で一つ。（日付の形式）
Directive Options:
	無し
Directive Content:
	無し

オプションとして与えることの出来るコードは、 Pythonのtime.strftime関数の形式です。デフォルトは、“%Y-%m-%d” (ISO 8601 date)です。

サンプル:

この文章は 2014-11-07 …詳細には 2014年11月07日01時06分54秒に作成されました。

コード:

.. |date| date::
.. |time| date:: %Y年%m月%d日%H時%M分%S秒

この文章は |date| …詳細には |time| に作成されました。

雑多なもの ¶

include…外部のドキュメントの一部(若しくは全部)を挿入する ¶

Directive Arguments:
Directive Type:	“include”
	インクルードするファイルのパスが必須
Directive Options:
	start-line: インクルードを開始する行を指定。通常pythonでは、一行目はゼロ、最終行はマイナス1。(整数) end-line: インクルードを終了する行を指定。(整数) start-after: 指定された文字列の最初の出現箇所以降をインクルードする。(string) end-before: 指定された文字列の最初の出現箇所までをインクルードする。(string) literal: インクルードされたテキスト全体を一つのリテラルブロックに挿入する。(flag) code: 指定された文字列でcodeディレクティブの解釈を行います。任意で言語を指定可能。(string) number-lines: code若しくはliteralを指定した場合、これを指定することで行番号が挿入されます。任意で最初の行番号を指定することが出来ます。(整数) encoding: インクルードするファイルのエンコーディングを指定できます。デフォルトはinput_encodingです。(string) tab-width: タブの幅を指定。マイナスだとタブを拡張しません。デフォルトはtab_widthです。(整数)
Directive Content:
	無し
Configuration Setting:
	file_insertion_enabled

警告

“include”ディレクティブは、潜在的なセキュリティーホールがあります。これの無効化は、file_insertion_enabledのランタイム設定から行えます。

コード例:

インデント(クォート)されていないところで、本ディレクティブを実行すると、
セクションなどの構造を含むことが出来ます。

.. include:: some.txt

～～～～～～～

    インデント（クォート）された場合は、セクション等の構造を含むことが出来ないかもしれません。

raw…生のデータの通過させる(reStructuredTextのマークアップのバイパス)¶

Directive Arguments:
Directive Type:	“raw”
	outputする形式が一つ以上必要.
Directive Options:
	file: インクルードするrawデータのローカルのパス (文字列) url: インクルードするrawデータのURL (文字列) encoding: rawデータのエンコーディング (エンコーディングの名前)
Directive Content:
	バイパスされる文字列。ファイルパス若しくは、URLが指定されれば無し。
Configuration Setting:
	raw_enabled

警告

“raw”ディレクティブは、潜在的なセキュリティーホールがあります。これの無効化は、raw_enabled若しくはfile_insertion_enabledのランタイム設定から行えます。

ご用心

この”raw”ディレクティブは、著者にreStructuredTextのマークアップをバイパスするための応急処置です。これはパワーユーザー用の機能で乱用されるべきではありません。ドキュメントの出力フォーマットに制限が生まれ、移植性が下がります。

“raw”ディレクティブや”raw”で生成されたテキストを度々使用する必要があれば、それは乱用かreStructuredTextの機能上の欠陥です。 Docutils-usersのメーリングリストまで連絡ください。

コード:

.. raw:: html

   <hr width=50 size=10>

.. raw:: latex

   \setlength{\parindent}{0pt}

.. raw:: html
   :file: inclusion.html

Class…クラスを指定する ¶

Directive Arguments:
Directive Type:	“class”
	クラスの名前若しくは属性の値が一つ以上必要
Directive Options:
	無し
Directive Content:
	任意。もし存在すれば、ボディ要素として解釈されます。

ヒント

sphinxでは、reStructuredTextのclassディレクティブがrst-classへと再定義されています。本ドキュメントは、sphinxで記述されているため、実例やサンプルではrst-classを利用します。

ディレクティブの引数は、一つ以上の半角スペースで区切られたクラス名です。クラス名は正規表現で、”[a-z](-?[a-z0-9]+)*”に合致する名前へと変換されます。要点は下記。

アルファベットは、小文字へ

アクセントされた文字は、基本文字へ(通常の日本語環境では、関係ないでしょう）

非英数字の文字は、ハイフンへ

連続したハイフンは、一つのハイフンへ

以下動作例。

ここは、”special”の段落です。

ここは、”special”の段落ではありません。

これはexceptional remakableクラスのセクションです(本章は動作例を示すためのものです。)¶

普通の段落。

“multiple”な段落。

ここも”multiple”な段落。

これは動作例を閉じるための章です ¶

ここまでが動作例

以下はhtmlのソース:

<p class="special">ここは、&#8221;special&#8221;の段落です。</p>
<p>ここは、&#8221;special&#8221;の段落ではありません。</p>
<div class="exceptional remarkable section" id="exceptional-remakable">
<h4><a class="toc-backref" href="#id71">これはexceptional remakableクラスのセクションです(本章は動作例です。)</a>
<a class="headerlink" href="#exceptional-remakable" title="Permalink to this headline">¶</a></h4>
<p>普通の段落。</p>
<p class="multiple">&#8220;multiple&#8221;な段落。</p>
<p class="multiple">ここも&#8221;multiple&#8221;な段落。</p>
</div>

以下は、コード:

.. rst-class:: special

ここは、"special"の段落です。

ここは、"special"の段落ではありません。

.. rst-class:: exceptional remarkable

これはexceptional remakableクラスのセクションです(本章は動作例です。)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

普通の段落。

.. rst-class:: multiple

   "multiple"な段落。

   ここも"multiple"な段落。

以下のように、”class”ディレクティブに続いて空のコメントをつけると、 <backquote>タグに対して、クラスが適応されます。空のコメントをつけない場合は、それぞれの要素(<p>タグで設定される)に対してclassが適応されます。

コード例:

.. rst-class:: highlights
..

Role…テキストロールをカスタムする ¶

Directive Arguments:
Directive Type:	“role”
	新しいロール名一つが必須で、基本ロール名が任意で一つ。
Directive Options:
	可能。但し、基本ロールに依存します。
Directive Content:
	基本ロールに依存

“role”ディレクティブは、解釈が行われるテキストロールを新しく定義して、パーサー（構文解析器）に登録できます。これは、後付けで新しいロールを定義できるということです。

ヒント

基本ロールについての詳しい記述は、”reStructuredText Interpreted Text Roles”で行われています。

ロールは、利用前の箇所で定義する必要があります。
基本ロールが指示されていない場合は、全体で設定されたロールが使用されます。続けて、Directige Optionsに:classを指定することが出来ます。

コード例1:

.. role:: raw-role(raw)
   :format: html latex

:raw-role:`raw text`

コード例2:

.. role:: custom
   :class: special

:custom:`interpreted text`

Default-role…デフォルトテキストロールを設定する ¶

Directive Arguments:
Directive Type:	“default-role”
	任意で一つ。(新しいデフォルトロール名).
Directive Options:
	無し。
Directive Content:
	無し。

“default-role”ディレクティブは、デフォルトのテキストロールをセットします。ロールが指示されていないテキストに適応されます。

以下のように設定が行えます:

.. default-role:: subscript

後に続けて、暗黙のロールとして解釈されるテキストを利用すると、 “subscript”ロールが使用されます。:

An example of a `default` role.

組み込まれたロールの詳細については”reStructuredText Interpreted Text Roles” を参照して下さい。このディレクティブは、アプリケーション環境に依存する初期設定されたデフォルトロールの引数を復元することなく、利用してしまうことがあります。 reStrucuteredTextの標準の初期設定デフォルトロールは、”title-reference”です。

title…メタデータ上のドキュメントタイトルを指定する ¶

Doctree Element:
Directive Type:	“title”
	無し。
Directive Arguments:
	タイトルの文字列が一つ必須(string)
Directive Options:
	無し。
Directive Content:
	無し。

“title”ディレクティブは、メタデータとしてのドキュメントタイトルを明記できます。これは、ドキュメントが供給するタイトルを上書きします。ここで指定したタイトルは、例えばhtmlでは、ブラウザウィンドウのタイトルバー等に表示されます。

Restructuredtext-Test-Directive ¶

Directive Arguments:
Directive Type:	“restructuredtext-test-directive”
	無し。
Directive Options:
	無し。
Directive Content:
	リテラルブロックとして解釈されるもの。

このディレクティブはテスト利用のものです。

これは、ディレクティブデータを表示するlevel-1(info)システムメッセージへと変換される。恐らく、続けてディレクティブブロックの残りの部分を含むリテラルブロックが続く。

共通オプション ¶

doctree要素の多くのディレクティブでは、下記のオプションが利用できます。

:class: : 文字列: クラス属性の値を設定できる。classディレクティブの項目も確認してください
:name: : 文字列: names属性に文字列を与えると、文字列を参照名として、ハイパーリンクの参照をその要素に与えることが出来ます。

name オプションを利用した例は以下

.. image:: bild.png
   :name: my picture

は、ハイパーリンクターゲットに代わる簡単な構文です。:

.. _my picture:

.. image:: bild.png

ナビゲーション

前のトピックへ

このページ

クイック検索

ナビゲーション