Мой `pdf`, сгенерированный через RTD, содержит все статьи контента в заголовке. Почему?

Question

Я только недавно (вчера) начал использовать sphinx и читать документы для моего проекта.

До сих пор я доволен HTML-документацией, но PDF-версия включает в себя все статьи, которые появляются в указателе в заголовке "Содержание". И содержимое / индекс документов просто состоит из двух ссылок.

Пожалуйста помоги.

Документация находится на http://todx.rtfd.io/ и PDF здесь.

Answer 1

При создании PDF Sphinx всегда добавляет контент, на который ссылается через .. toctree:: директива точно, где директива размещена. Напротив, при генерации HTML Sphinx размещает контент после файла, который содержит toctree,

В этом аспекте генерация PDF и генерация HTML просто несовместимы.

Таким образом, вы должны поместить все содержимое страницы индекса перед оглавлением.

Если вы хотите предоставить краткий обзор наиболее важных разделов, вы можете использовать список ссылок. Затем вы можете скрыть toctree с использованием hidden свойство, например так:

Contents
--------

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

Features
--------

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

.. toctree::
   :hidden:

   quickstart
   userguide