ページ内の目次を作りたい¶
contents
を使います。
contents
はページ内のセクションに対してリンクを作ります。以下のオプションが使えます。
- 文字列
目次のタイトルを指定します。必ず他のオプションより先か、
contents
ディレクティブと同じ行に書いてください。- :depth: <数値>
目次に含めるセクションの深さを指定します。指定がない場合はすべてのセクションを目次に含めます。
- :local:
このディレクティブ以降にあるセクションだけを目次に含めます。指定がない場合はページ内のセクションをすべて含む目次を作ります。
また、このオプションを指定すると目次のタイトルがなくなりますので、別途指定してください。
- :backlinks:
セクションから目次に戻るリンク(バックリンク)に対しての動作を決めます。以下の引数を持ちます。
引数
動作
entry
目次の各項目に対してバックリンクを作ります(デフォルト)。
top
目次のタイトルに対してバックリンクを作ります。
none
バックリンクを作りません。
適応例¶
.. contents:: これは目次です
:depth: 2