【问题标题】:Place minor pages in the right place in the TOC将次要页面放在目录中的正确位置
【发布时间】:2016-02-26 18:43:21
【问题描述】:

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

如果我的“第 3 部分”页面如下所示:

.. toctree::
   3.3
   3.4

3
=====



3.1
-----


3.2
---

然后3.33.4 列在之前 3

我尝试了其他排列,但似乎都不起作用。

  1. 如果我将目录树放在3 标题之后,那么3.33.4 将列在33.1 之间。
  2. 如果我将目录树放在页面末尾,一切都按正确的顺序排列,但3.33.4 成为第三级部分,3.2 部分的子部分。

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

【问题讨论】:

    标签: python-sphinx sections read-the-docs toctree


    【解决方案1】:

    要获得正确的一般结构,您可以使用include directive,如下所示:

    3
    =====
    
    3.1
    -----
    
    3.2
    ---
    
    .. include:: 3_3.rst
    
    .. include:: 3_4.rst
    

    不过,没有好的方法可以将这些部分列在同一页面的目录树中。在 toctree 中列出 self 只会显示第一级标题和直接自引用 - 在您的示例中为 further-detail-1 - 将适用于 html(尽管它会导致警告),但会混淆 latexpdf 构建.

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2011-06-25
      • 1970-01-01
      • 2017-07-29
      • 1970-01-01
      • 2011-07-02
      • 2021-09-25
      • 2012-06-13
      • 2021-09-23
      相关资源
      最近更新 更多