要创建多级toctree子子页面的层次结构,可以按照以下步骤进行操作:
- 在Sphinx项目的主目录中创建一个名为
source
的文件夹(如果尚未存在)。
- 在
source
文件夹中创建一个名为index.rst
的文件,作为项目的主索引文件。
- 在
index.rst
文件中使用toctree
指令来定义子页面的层次结构。例如:
.. toctree::
:maxdepth: 2
page1
page2
folder1/index
folder2/index
上述示例中,toctree
指令定义了一个最大深度为2的目录结构。page1
和page2
是第一级子页面,folder1
和folder2
是第一级子文件夹。在每个文件夹下,使用index
文件作为每个子文件夹的索引文件。
- 在
source
文件夹中创建对应的子页面和子文件夹,并在每个页面或文件夹中创建一个名为index.rst
的文件,作为子页面或子文件夹的索引文件。例如:
- 创建
page1.rst
和page2.rst
文件作为第一级子页面。
- 创建
folder1
和folder2
文件夹,并在每个文件夹中创建index.rst
文件。
- 在每个子页面或子文件夹的
index.rst
文件中编写对应的文档内容。
通过以上步骤,就可以创建一个多级toctree子子页面的层次结构。在生成文档时,Sphinx将按照toctree指令中定义的结构来生成目录和链接。