在toctree中使用self不包括子节。

问题描述 投票:6回答:1

我想让我在sphinx中的toctree包含主页面(index.rst)。文档建议包括'self'就可以做到这一点,但正如其他人在stackoverflow上所指出的,这只包括主页面的标题,所以如果深度> 1,主页面的行为与链接页面不同。

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

python python-sphinx toctree
1个回答
1
投票

包括字面意思 self 只是添加了你提到的当前文档的标题。然而,包括当前文档的标题实际上是把它添加到树上。例如

.. toctree::
    :maxdepth: 2

    index

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

© www.soinside.com 2019 - 2024. All rights reserved.