python-sphinx - 在索引目录树中包含子目录中的目录树

标签 python-sphinx subdirectory 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

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

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

最佳答案

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

内容:

.. toctree::
   :maxdepth: 2

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

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

关于python-sphinx - 在索引目录树中包含子目录中的目录树,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/38904668/

相关文章:

makefile - Sphinx 的默认 Makefile

python-sphinx - 使用 self 在 sphinx 中创建带有 toctree 的站点地图似乎坏了?

python-sphinx - 从主 TOCTree 中隐藏 Sphinx 子部分

python-sphinx - 如何使toctree链接像引用小节一样引用单独的文件

Python Sphinx 在生成 pdf 时跳过第一部分

csv - 由 rst 的 sphinx latexpdf 生成的 pdf 中的丑陋破损表格

image - 文档 : missing images when using include directives (rst, 狮身人面像)

mercurial - 如何使人们注意到添加到子目录中的文件? ( Mercurial ST, Mercurial 添加)

java - Intellij 资源子文件夹不包含在类路径中

Windows 批处理文件 - 显示所有子文件夹