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

时间:2014-12-07 00:36:23

标签: python python-sphinx

我希望我在sphinx中的toctree包含main(index.rst)页面。文件表明,包括“自我”和“自我”。会这样做,但正如其他人在stackoverflow上所说,这只包括主页面的标题,所以如果深度> 1主页面的行为与链接页面不同。

我也看到了针对这个问题的内容指令,对我来说,这只是创建了一个单独的本地内容列表,并没有帮助toctree。我真的在寻找能够在toctree中产生一致行为的解决方案。有吗?

1 个答案:

答案 0 :(得分:0)

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

.. toctree::
    :maxdepth: 2

    index

将产生您想要的结果。我不确定为什么这个没有在文档中明确列出。