Sphinx / reStructuredText: возможно ли иметь одно дерево HTML-документов, но разбить его на отдельные документы в формате латекс / PDF - PullRequest
Новая
       11

Sphinx / reStructuredText: возможно ли иметь одно дерево HTML-документов, но разбить его на отдельные документы в формате латекс / PDF

0 голосов
/ 17 апреля 2019

Я работаю над большим проектом документации с использованием Python-Sphinx. Я только начал и сумел преодолеть первые препятствия и создал структуру папок, ориентированную на отдельные подпроекты, способствующие общему проекту: 

.../source/
    conf.py
    index.rst (braket file for everything)
    /OverViewDocumentation/
        overview.rst
    /Subprojects/
        /sub1/
            index.rst
            sub1Docu.rst
        /sub2/
            indexfile.rst
            sub2Docu.rst

Я хотел бы видеть, что эта структура доступна через одну HTML-структуру, но листовые документы становятся отдельными документами LaTeX / PDF.

Может ли это быть достигнуто?

Мой conf.py выглядит следующим образом: 

latex_documents = [
    (master_doc,
     'TexDoc1.tex',
     'Title1',
     'author1',
     'Custom docclass'),
    ('abolute\\path\\to\\other\\indexfile.rst',
     'TexDoc2.tex',
     'Title2',
     'author2',
     'Custom docclass'), 
]

Но я всегда получаю сообщение об ошибке: 

WARNING: "latex_documents" config value references unknown document <pathto>\indexfile

Обратите внимание, что ошибка возникает независимо от того, использую ли я абсолютный или относительный путь.

1 Ответ

0 голосов
/ 17 апреля 2019

Благодаря подсказкам mzjn я нашел решение.

Ошибка была в файле conf.py.Рабочий файл выглядит следующим образом: 

latex_documents = [
    (master_doc,
     'TexDoc1.tex',
     'Title1',
     'author1',
     'Custom docclass'),
    ('relative/path/to/other/indexfile',
     'TexDoc2.tex',
     'Title2',
     'author2',
     'Custom docclass'), 
]

В приведенном выше файле у меня были следующие проблемы

  • использование обратной косой черты вместо косой черты (я работаю в системе Windows)
  • использование абсолютного пути
  • использование явного расширения файла для indexfile
...