在 toctree 中使用 self 不包括子部分

Question

我希望我在 sphinx 中的目录树包含主 (index.rst) 页面。文件建议包含“self”将执行此操作，但正如其他人在 stackoverflow 上指出的那样，这仅包括主页的标题，因此如果 depth > 1，则主页的行为与链接页面不同。

我还看到了针对此问题建议的内容指令，对我来说，这只是创建了一个单独的本地内容列表，对目录树没有帮助。我真的在寻找一种在目录树中产生一致行为的解决方案。有吗？

Answer 1

包括文字self 只是添加了您提到的当前文档的标题。但是，包含当前文档的标题实际上会将其添加到树中。例如，

.. toctree::
    :maxdepth: 2

    index

会产生你想要的结果。我不知道为什么这没有在某处的文档中明确列出。