目次したい(toctree
)
1```{toctree}
2---
3maxdepth: 1
4caption: 目次のキャプション
5name: ラベル名
6---
7ファイル名1
8ファイル名2
9ファイル名3
10```
ドキュメントの目次を自動生成するには、toctree
ディレクティブを使います。
参考
reST形式で書くと次のようになります。
.. toctree::
:maxdepth: 1
:caption: 目次のキャプション
:name: ラベル名
:numbered:
ファイル名1
ファイル名2
ファイル名3
目次の深さを設定したい(maxdepth:
)
ファイルの中にある見出しを表示する深さを設定できます。
このドキュメントのように、ファイルを小さな単位に分割して
管理している場合は maxdepth: 1
に設定するとよいと思います。
1```{toctree}
2---
3maxdepth: 1
4---
5ファイル名1
6ファイル名2
7ファイル名3
8```
目次にキャプションをつけたい(caption:
)
1```{toctree}
2---
3caption: 目次のキャプション
4---
5ファイル名1
6ファイル名2
7ファイル名3
8```
目次を参照したい(name:
)
1```{toctree}
2---
3name: ラベル名
4---
5ファイル名1
6ファイル名2
7ファイル名3
8```
章番号を表示したい(numbered:
)
1```{toctree}
2---
3numbered:
4---
5ファイル名1
6ファイル名2
7ファイル名3
8```
HTMLドキュメントでも章番号を表示したい場合は、numbered:
オプションを指定します。