在索引 toctree 中包含来自子目录的 toctree

Include toctree from subdirectory in Index toctree

我要记录的项目结构如下:

/top
Index.rst
     /a
     toctree_a.rst (contains doc and doc2)
     doc.rst
     doc2.rst
     /b
     toctree_b.rst (contains doc4 and doc3)
     doc3.rst
     doc4.rst

我想引用子目录(a 和 b)中的 toctree 以便项目 toctree 可以看到项目树中的 4 个文件。

我知道当文档在一个目录中时该怎么做,但如果我将它们放在子目录中,我不知道该怎么做。我试图保持我的项目结构完整,而不必将所有文件移动到一个目录中。我做了一些研究,发现 .. include:: directive 可能是要走的路,但我不知道如何正确使用它。

您可以在 index.rst 中告诉您的 toctree 从子目录中获取文件,如下所示:

内容:

.. toctree::
   :maxdepth: 2

    a/doc
    a/doc2
    b/doc3
    b/doc4

该方法的工作原理就像它们在同一目录中一样