将子目录中的toctree包含在索引toctree中。

Question

我想记录的项目结构如下。

/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

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

我知道当文件在一个目录中时如何做，但我不知道如果我把它们放在一个子目录中如何做。 我试图保持我的项目结构完整，而不需要将所有文件移到一个目录中。 我做了一些研究，发现 .. include:: directive 可能是个好办法，但我不知道如何正确使用它。

Answer 1

你可以在index.rst中告诉你的toctree从一个子目录中获取文件，就像这样。

Contents:

.. toctree::
   :maxdepth: 2

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

这个方法的工作原理就像它们在同一个目录下一样。