Python-sphinx-如何防止自动toctree条目编号

问题描述 投票:0回答:1

已修复,通过输入make clean html然后输入make html来重建项目。

我正在使用Sphinx构建我的文档,以用于readthedocs.io。到目前为止,这一直很好。我正在针对godot engine的出色文档(我认为)。

由于我很欣赏godot文档中的标题,因此我通过首先查看它们的制作方式来尝试复制它们。 Here's the link to the source for their index file.(注意:相关部分位于文档末尾)

这似乎很合理,因为他们使用了多个toctree,为每个toctree指定了标题。

但是,当我执行相同操作时,狮身人面像似乎会自动为我的部分编号,这是我不想要的。 toctree不包含:numbered:标记。

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

.. toctree::
    :caption: Section 1

    Entry1
    Entry2

.. toctree::
    :caption: Section 2

    Entry3

[所有文件都在一个根文件夹中,包含Entry1.rst,Entry2.rst等,这是文件夹结构的树表示,

/source/
│   conf.py
│   Functions.rst
│   index.rst
│   Installation.rst
│   Licence.rst
│   Privacy.rst
│   Setup.rst
│   Usage.rst
│
├───_static
└───_templates

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

Getting started
    1.Installation
    2.Setup
    3.Usage

Legal
    3.Privacy
    4.Licencing

Development
    1.Emulation
    2.Functions

我在godot文档中找不到任何解释它们为何没有这些数字的内容,在Sphinx toctree documentation中也找不到任何提及。

非常感谢任何帮助或寻求帮助的指点,谢谢您的宝贵时间。

编辑:上载存储库以及内置的静态html文件以读取thedocs.io似乎可以删除/修复编号。不过,它仍然存在于本地生成的文件中(首先是我用sphinx生成的index.html文件)。

python python-sphinx read-the-docs
1个回答
0
投票

问题的答案,由[[mzjn提供(请参见评论主题):

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

make clean html

make html

在控制台中,解决了奇怪的编号问题。

The relevant github issue can be found here.

这可能是由于狮身人面像试图查找代码中的更改并进行更新,而不是每次都重新构建项目。在这种情况下,它没有正确更新toctree。

© www.soinside.com 2019 - 2024. All rights reserved.