Sphinx добавляет индекс всего модуля в сгенерированный PDF

Я использую Sphinx autodoc для создания документации по Python, которая затем размещается в ReadTheDocs здесь. PDF-файл, созданный ReadTheDocs, содержит только оглавление моей индексной страницы, которое вы можете увидеть здесь.

Я хочу, чтобы PDF-файл также содержал весь индекс моего модуля и документы для каждого модуля/функции: http://sensormotion.readthedocs.io/en/develop/source/sensormotion.html

По сути, я хочу, чтобы мой индекс TOC и страницы полного модуля были объединены в один и тот же PDF-файл.

Какие настройки мне нужно изменить в моем conf.py для достижения этой цели?

В настоящее время у меня есть только параметры latex_documents по умолчанию:

latex_documents = [
    (master_doc, 'index.tex', project + ' Documentation',
     author, 'howto'),
]

Я попытался добавить еще один кортеж в список фактических ссылок на модули/функции, но, похоже, ничего не добавлено в PDF:

latex_documents = [
    (master_doc, 'index.tex', project + ' Documentation',
     author, 'howto'),
    ('sensormotion', 'sensormotion.tex', project + ' Documentation',
     author, 'howto'),
]

person Simon    schedule 20.04.2018    source источник
comment
Это странно. Я ожидаю, что пакет будет задокументирован как для версий HTML, так и для PDF или ни для одной, но не только для HTML. Вы пытались создать PDF локально? Я заметил несколько предупреждений в журнале сборки при нажатии на каждый элемент, но ничего выделяется. Ваш conf.py тоже выглядит нормально. Сравните со по умолчанию Sphinx conf.py.   -  person Steve Piercy    schedule 20.04.2018
comment
Попытка заставить работать rst2pdf (Windows) была проблемой, поэтому я не смог создать pdf локально. Если вы посмотрите на мои документы на RTD, вы увидите, что список модулей не включен ни в какие оглавления, и единственный способ получить к нему доступ — через ссылку через указатель модулей Python — может ли это быть причиной того, что он не включен в оглавление? пдф?   -  person Simon    schedule 20.04.2018
comment
Это может быть. Попробуйте.   -  person Steve Piercy    schedule 20.04.2018


Ответы (1)


Вы не ссылаетесь на первые файлы под docs/source из вашего index.rst. Я думаю, что, возможно, построитель HTML ищет все первые файлы в документах, в то время как построитель LaTeX отображает файлы, которые вы явно перечисляете в latex_documents (он создает один выходной PDF-файл для каждой записи в этом списке).

person Brecht Machiels    schedule 20.04.2018
comment
Итак, две вещи: 1) как я могу ссылаться на исходные файлы в index.rst, фактически не отображая их на странице? и 2) В моем втором примере я добавил один из исходных файлов в latex_documents, но, похоже, он не добавляется в PDF - person Simon; 21.04.2018
comment
@Simon 1) вы ссылаетесь на файл в своем toctree и 2) каждая запись в latex_documents list создает отдельный исходный файл латекса, поэтому, если вы не объедините их самостоятельно впоследствии, они создадут отдельные файлы PDF. - person Brecht Machiels; 23.04.2018