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

我想在子目录（a和b）中引用toctree，以便项目toctree可以在项目树中看到4个文档。我知道当文档在一个目录中时如何做到这一点，但如果我将它们放在子目录中，我就不知道如何做到这一点。我试图保持我的项目的结构完整，而不必将所有文件移动到一个目录中。我做了一些研究，发现... include :: directive可能是要走的路，但我无法弄清楚如何正确使用它。谢谢你的帮助！

Answer 1

你可以在index.rst中告诉你的toctree从子目录中获取文件，如下所示：

内容：

.. toctree::
   :maxdepth: 2

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

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

Sphinx - 在Index toctree中包含子目录中的Toctree

1 个答案: