TOC 树

由于reST不便于多个文件相互关联或者分割文件到多个输出文件中，Sphinx通过使用自定义的指令（标识符）来处理构成文档的单个文件的关系，这同样使用与内容表。toctree 指令（标识符）就是核心要素。

Note

使用 include 指令（标识符）能够实现简单的一个文件在另一个文件的“包含”。

.. toctree::

Sphinx保留了一些供自己使用的文件名，你不应该试图创建具有这些名称的文件 - 这将导致问题。

特殊的文件名（和他们生成的页面名）是：

• genindex, modindex, search

  这些都是分别用于总索引，Python模块索引，和搜索页。

  总索引用于模块和所有的生成索引 object descriptions 的条目，以及 index 指令（标识符）。

  Python模块索引包含了每一个 py:module 指令（标识符）条目。

  搜索页包含一个生成的JSON搜索索引和JavaScript的形式，它使用全文搜索在生成的文件中搜索关键词，它应该兼容每一个主要的浏览器，支持最新的JavaScript。

• 以 _ 开头的名称

  尽管目前Sphinx只使用少数带 _ 开头的名称，你应该不要创建这样的文件名或者目录名。

Footnotes

[1]	maxdepth 选项对LaTeX不起作用，内容始终是在文档的最前面，它的深度可以通过 tocdepth 来控制，你可以重设 latex_preamble 配置值。例如： \setcounter{tocdepth}{2}。

[2]	可用的匹配格式提示：你可以用标准的shell格式 *, ?, [...] and [!...]。