sphinx:将小页放在TOC的正确位置

时间:2016-02-26 18:43:22

标签: python-sphinx read-the-docs

在我的狮身人面像文档中,我有一些小页面(当然)需要成为toctree的一部分,但我无法将它们列在正确的位置。

如果我的"第3节"页面看起来像这样:

.. toctree::
   3.3
   3.4

3
=====



3.1
-----


3.2
---

然后在 3.3之前列出 3.43

我尝试了其他排列,但似乎都没有效果。

  1. 如果我在3标题之后放置了toctree,那么3.33.4会在 33.1之间列出
  2. 如果我将toctree放在页面的末尾,那么一切都是正确的顺序,但3.33.4成为第三级部分,3.2部分的子项。< / LI>

    我在这里提出了一个具体的例子:

1 个答案:

答案 0 :(得分:0)

要使一般结构正确,您可以按如下方式使用include directive

3
=====

3.1
-----

3.2
---

.. include:: 3_3.rst

.. include:: 3_4.rst

尽管如此,没有好办法让这些部分在同一页面上的toctree中列出。 toctree中的列表self将仅显示第一级标题,并且直接自引用 - 在您的示例中为further-detail-1 - 将适用于html(尽管它会导致警告),但是搞乱了latexpdf构建。

作为一种解决方法,您只需使用references列表对您自己的toctree进行硬编码。