基本 (3) - ディレクティブとロール-¶
ディレクティブ¶
ディレクティブ（Directive）とは¶
reStructuredTextで使うブロック要素の命令．
複数行にわたる構造的な記述（例：コードブロック、図、表など）に使われ、 ".." で始まる．
.. code-block::
$ ls -alt
ディレクティブの例¶
ディレクティブ名 |
用途 |
|---|---|
code-block |
コードブロック（構文ハイライト付き） |
image |
画像の挿入 |
table |
表の挿入 |
note |
注釈（装飾付きボックス） |
warning |
警告表示ボックス |
figure |
キャプション付き画像 |
toctree |
目次ツリーの構築 |
include |
外部ファイルの読み込み |
literalinclude |
外部ソースコードの読み込み |
math |
数式の表示（LaTeX形 |
ロール（Role）とは¶
テキスト中のインライン装飾や参照を付ける命令．
1行内で使われ、 ":role:" のような書式で指定、強調・リンク・変数表記などを担う．
:math:`y=\sin(x)`
ロールの例¶
ロール名 |
用途 |
|---|---|
ref |
他ドキュメント内への参照 |
doc |
他ファイルへのリンク |
math |
インライン数式 |
code |
インラインコード（整形付き） |
emphasis |
強調（イタリック） |
strong |
太字 |
literal |
等幅テキスト |
title |
書籍などの題名表記 |
sub |
下付き文字 |
sup |
上付き文字 |
