Структура каталогов Sphinx для сгенерированных файлов rst и html

Я работал над настройкой автоматической документации для моих файлов Python, которые находятся в большой иерархии структуры каталогов. Я могу сгенерировать файлы rst и html для всех из них с помощью моих скриптов и с помощью модуля autodoc. Мне было интересно, можно ли сгенерировать файлы rst и html в той же структуре каталогов / иерархии каталогов, что и мои файлы Python.

например, относительный путь к моему файлу python: python / common / element.py; первый сгенерированный файл: python.common.element.rst; и то же самое для html. Я хочу, чтобы он сформировал ту же структуру каталогов, что и для файлов py, например: sphinx / _build / rst / python / common / element.rst & sphinx / _build / html / python / common / element.html

PS: я работаю над ubuntu-14.04 и Sphinx-1.6.3


person Akshay Shah    schedule 15.09.2017    source источник


Ответы (1)


Нет. Каталоги исходного кода и сборки должны быть отдельными. См. Параметры в sphinx-build.

Вы можете написать сценарий для последующей обработки вывода, перемещая файлы из каталога сборки в другой.

person Steve Piercy    schedule 15.09.2017
comment
Да, очевидно, что каталоги исходного кода и сборки будут разными. Но мой вопрос заключался в том, чтобы сделать это внутри самого каталога сборки. В любом случае, я напишу сценарий для того же самого, чтобы перемещать и упорядочивать файлы после sphinx-build. - person Akshay Shah; 15.09.2017
comment
Ответ по-прежнему отрицательный, поскольку каждый выходной формат имеет свой собственный подкаталог в каталоге сборки. Сценарий пост-обработки - ваш единственный вариант. - person Steve Piercy; 16.09.2017