Автодокументирование Python с помощью Сфинкса
При создании процесса с помощью CreateProcess () , можно выбрать HANDLE, к которому stdout и stderr будут записанными. Это HANDLE может быть файлом, к которому Вы направляете вывод.
Это позволит Вам использовать код, не перекомпилировав его. Просто выполните его и вместо того, чтобы использовать system() или этажерка, используйте CreateProcess().
ДЕСКРИПТОР Вы даете CreateProcess(), может также быть ДЕСКРИПТОР канала, который Вы создали, и затем можно читать из канала и сделать что-то еще с данными.
4 ответа
Чтобы упростить задачу, вы можете использовать этот скрипт (последнюю версию смотрите внизу страницы): http://bitbucket.org/birkenfeld/sphinx/issue/98/add-the-autogenerate-script-to-sphinx
Этот скрипт проанализирует ваши пакеты / модули и сгенерирует все остальные файлы, необходимые для сборки документ из строк документации.
Я являюсь первоначальным автором этого сценария.
ОБНОВЛЕНИЕ
Этот сценарий теперь является частью Sphinx 1.1 как apidoc .
Я думаю, что глупо добавлять директиву autofunction или automdule для каждой функции; Должен быть способ автоматизировать процесс, иначе я не вижу смысла использовать Sphinx вообще.
Я бы предложил Epydoc , который специализируется на создании документации из строк документации.
Вы хотите, чтобы это было проще, чем просто указать автоматическое расписание? Даже для большой библиотеки требуется 5 минут работы, чтобы ввести все имена модулей.
Причина этого в том, что Sphinx с трудом угадывает, что нужно документировать.
Вы также можете написать автопакет, который будет искать модулями и используйте директиву autodule (если автопрограмма этого еще не делает).