Автодокумент сфинкса не является достаточно автоматическим
Я пытаюсь использовать Сфинкса для документирования 5,000 + проект строки в Python. Это имеет приблизительно 7 основных модулей. Насколько я знаю для использования автодокумента, я должен написать код как это для каждого файла в моем проекте:
.. automodule:: mods.set.tests
:members:
:show-inheritance:
Это слишком утомительно, потому что у меня есть много файлов. Было бы намного легче, если я мог бы просто указать, что хотел, чтобы пакет 'модификаций' был зарегистрирован. Сфинкс мог затем рекурсивно пройти пакет и сделать страницу для каждого подмодуля.
Существует ли функция как это? Если бы не я мог бы записать сценарий для создания всех .rst файлов, но это заняло бы много времени.
2 ответа
Вы можете проверить этот скрипт , который я сделал. Думаю, это может тебе помочь.
Этот сценарий анализирует дерево каталогов в поисках модулей и пакетов python и создает файлы ReST, чтобы создать документацию по коду с помощью Sphinx. Он также создает индекс модулей.
ОБНОВЛЕНИЕ
Этот скрипт теперь является частью Sphinx 1.1 как apidoc .
В каждом пакете файл __ init __. Py может иметь компоненты .. automodule :: package.module за каждую часть пакета.
Затем вы можете .. automodule :: package , и в основном он делает то, что вы хотите.