首页 > 解决方案 > 如何防止自动toctree条目编号?

问题描述

我正在使用 Sphinx 构建我的文档,以与 readthedocs.io 一起使用。到目前为止,这一直运作良好。我将自己定位于(在我看来)godot engine的优秀文档。

由于我很欣赏 godot 文档中的标题,因此我尝试复制这些标题,首先看看他们是如何做到的。这是他们的索引文件的源链接。(注:相关章节在文件末尾)

这似乎是合理的,因为他们使用多个 toctree 来为每个 toctree 提供标题。

然而,当我这样做时,狮身人面像似乎会自动为我的部分编号,这是我不想要的。目录树不包含 :numbered: 标签。

这是一个代码示例,解释了我的目录树的结构原则:

.. toctree::
    :caption: Section 1

    Entry1
    Entry2

.. toctree::
    :caption: Section 2

    Entry2

预期的结果将类似于 godot 文档,部分有标题但没有编号。相反,我得到的数字对我来说似乎是任意的:

Section1
    1.Entry1
    2.Entry2

Section2
    1.Entry1

我在 godot 文档中找不到任何解释为什么他们没有这些数字的东西,而且我在Sphinx toctree 文档中也找不到任何提及。

非常感谢任何帮助或指向帮助的指针,感谢您的宝贵时间。

编辑:上传存储库,以及构建的静态 html 文件到 readthedocs.io 似乎删除/修复了编号。它仍然存在于本地构建中(我首先使用 sphinx 构建的 index.html 文件)。

标签: pythonpython-sphinxread-the-docstoctree

解决方案


问题的答案,由mzjn提供(见评论线程):

项目的重建解决了这个问题。这可以通过输入来完成

make clean html

在控制台中,修复了奇怪的编号问题。

相关的 github 问题可以在这里找到。

这可能是由于 sphinx 试图查找代码中的更改并更新这些更改,而不是每次都重新构建项目。在这种情况下,它没有正确更新目录树。


推荐阅读