2016-05-25 4 views
-1

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

До сих пор я доволен документом Html, но в pdf-версии представлены все статьи, которые появляются в индексе в заголовке Содержание. И содержание/индекс документов orignal просто состоит из двух ссылок.

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

Документация находится на http://todx.rtfd.io и в формате pdf here.

ответ

0

При создании 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