TOC Tree

toctreeは、ドキュメントを構成するファイル群の関係を指定するためのものです。

使い方

.. toctree::
   :maxdepth: 2
   :numbered:
   :caption: caption text
   :name: name text
   :titlesonly:
   :glob:
   :hidden:
   :includehidden:

   原稿ファイルの名前

オプション	内容
maxdepth	表示する目次の深さ
numbered	番号を付ける
caption	キャプションを表示
name	参照のターゲットの指定
titlesonly	タイトルだけを表示
glob	ワイルドカードで指定
hidden	表示しない
includehidden	ネストしたtoctreeを表示しない

使用例

下記のような５つのファイルで構成されるプロジェクトがあるとします。

index.rst

.. toctree::
   :maxdepth: 2

   foo.rst
   bar.rst

foo.rst

フー
====

.. toctree::
   :maxdepth: 2

   hoge.rst
   piyo.rst

bar.rst

バー
====

hoge.rst

ほげ
====

piyo.rst

ぴよ
====

各ファイルの関係はこのようになります。ファイル自体は同じフォルダにあります。

index.rst
├foo.rst
│├hoge.rst
│└piyo.rst
└bar.rst

これをHTMLに変換するとこうなります。

index.rstを下記のように書き換えてみます。

index.rst

.. toctree::
   :maxdepth: 2
   :numbered:

   foo.rst
   bar.rst

numberedオプションがつきましたね。これをHTMLに変換するとこうなります。