Question

我刚刚（昨天）开始使用sphinx并阅读我project的文档。

到目前为止，我对Html文档感到满意，但pdf版本包含了内容标题中索引中出现的所有文章。而文档的内容/索引只包含两个链接。

请帮忙。

文档位于http://todx.rtfd.io，pdf为here。

Answer 1

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

在这方面，PDF生成和HTML生成简直不一致。

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

如果您想要提供最重要的内联部分的概述，可以使用references列表。然后，您可能希望使用toctree属性隐藏hidden，例如：

Contents
--------

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

Features
--------

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

.. toctree::
   :hidden:

   quickstart
   userguide

我通过RTD生成的`pdf`是标题内容中的所有内容文章为什么？

1 个答案: