python-sphinx - 我通过 RTD 生成的“pdf”在标题内容中包含所有文章内容 为什么？

Question

我最近（昨天）才开始使用 sphinx 并阅读了我的项目的文档。

到目前为止，我对 Html 文档感到满意，但 pdf 版本包括出现在目录标题内索引中的所有文章。文档的原始内容/索引仅由两个链接组成。

请帮忙。

文档位于http ://todx.rtfd.io，pdf 位于此处。

Answer 1

生成 PDF 时，Sphinx 始终将通过.. toctree::指令引用的内容准确地添加到指令所在的位置。相反，在生成 HTML 时，Sphinx 将内容放在包含toctree.

在这方面，PDF 生成和 HTML 生成根本不一致。

因此，您应该将索引页面的所有内容放在目录之前。

如果您想在线提供最重要部分的概述，您可以使用参考列表。然后，您可能想要隐藏toctreeusinghidden属性，例如：

Contents
--------

- :ref:`quickstart`
- :ref:`userguide`

Features
--------

- Fast
- Simple
- Inituitive
- Easy to Use
- Offline
- Open Source

.. toctree::
   :hidden:

   quickstart
   userguide