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

4
我要翻译的内容如下:

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

/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::指令可能是正确的方法,但我无法弄清楚如何正确使用它。
1个回答

8
您可以在index.rst中的toctree中指定子目录来获取文件,方法如下:

目录:

.. toctree::
   :maxdepth: 2

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

这种方法的工作方式就像它们在同一个目录中一样。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接