python-sphinx - 将次要页面放在目录中的正确位置

Question

在我的 sphinx 文档中，我有一些小页面（当然）需要成为目录树的一部分，但我无法将它们列在正确的位置。

如果我的“第 3 节”页面如下所示：

.. toctree::
   3.3
   3.4

3
=====



3.1
-----


3.2
---

然后3.3和之前3.4都列出来了。 3

我尝试了其他排列，但似乎没有一个有效。

1. 如果我将目录树放在3标题之后，则在3.3和之间3.4列出。 33.1
2. 如果我将目录树放在页面的末尾，一切都按正确的顺序排列，但3.3成为3.4第三级部分，即 section 的子级3.2。

---

我在这里举了一个具体的例子：

• http://sphinx-problem.readthedocs.org/en/latest/
• https://github.com/bukzor/sphinx-problem

Answer 1

要获得正确的一般结构，您可以使用include 指令，如下所示：

3
=====

3.1
-----

3.2
---

.. include:: 3_3.rst

.. include:: 3_4.rst

尽管如此，没有好的方法可以将这些部分列在同一页面的目录树中。目录self树中的列表只会显示第一级标题和直接的自我引用 - 在您的示例中further-detail-1- 将适用于 html（尽管它会导致警告），但会弄乱latexpdf构建。

作为一种解决方法，您可以简单地使用引用列表对您自己的目录树进行硬编码。