我正在用Sphinx构建我的文档,以便与readthedocs.io一起使用。到目前为止,这一直都很好。我正在将自己的方向定位在(在我看来)优秀的文档中。戈多引擎.
由于我很欣赏godot文档中的标题,我试图复制这些,先看看他们的做法。下面是他们索引文件的源头链接。 (注意:相关部分在文件的最后)
这似乎是合理的,因为他们使用多个toctree,给每个toctree一个标题。
然而,当我做同样的事情时,sphinx似乎会自动给我的部分编号,这是我不希望看到的。这些toctrees不包含:numbered:标签。
这里是一个代码示例,解释了我的toctrees的结构原理。
.. 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似乎可以删除fix编号。不过它在本地构建的文件中仍然存在(我一开始用sphinx构建的index.html文件)。
这个问题的答案,由 mzjn (见评论主题)。
重建项目解决了这个问题。这可以通过输入
make clean html
中,修复了奇怪的编号问题。
这可能是由于sphinx试图找到代码中的变化并更新这些,而不是每次都重建项目造成的。在这个例子中,它没有正确更新toctree。