首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何防止toctree条目自动编号?

如何防止toctree条目自动编号?
EN

Stack Overflow用户
提问于 2019-11-16 16:23:28
回答 1查看 338关注 0票数 0

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

因为我欣赏godot文档中的标题,所以我尝试复制这些标题,首先看看他们是如何做到这一点的。Here's the link to the source for their index file. (注:文档末尾有相关章节)

这似乎是合理的,因为他们使用了多个toctree,给每个toctree一个标题。

然而,当我做同样的事情时,sphinx似乎会自动给我的部分编号,这是我不想要的。目录树不包含:numbered:标记。

这是一个代码示例,解释了我的toctree原则上是如何构造的:

代码语言:javascript
复制
.. toctree::
    :caption: Section 1

    Entry1
    Entry2

.. toctree::
    :caption: Section 2

    Entry2

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

代码语言:javascript
复制
Section1
    1.Entry1
    2.Entry2

Section2
    1.Entry1

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

我们非常感谢您的帮助和指点,感谢您的宝贵时间。

编辑:将带有构建的静态html文件的存储库上传到readthedocs.io似乎会删除/修复编号。它保存在本地构建的文件中(我首先使用sphinx构建的index.html文件)。

EN

回答 1

Stack Overflow用户

发布于 2019-11-16 17:19:31

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

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

代码语言:javascript
复制
make clean html

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

The relevant github issue can be found here.

这可能是因为sphinx试图找到代码中的更改并更新这些更改,而不是每次都重新构建项目。在这种情况下,它没有正确地更新toctree。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/58888871

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档