Python-сообщество

Подскажите, пожалуйста, софт для автоматической генерации документации.
Необходимо примерно следующее: код изначально хорошо закомментирован, потом я запуская софтину (или она сама запускается время от времени) и генерит документации, которую при желании можно подправить.
Я смотрел в сторону sphinx, но, на сколько я понял, этот движок генерит доки из изначально подготовленных файлов в специальном формате. В нем есть возможность не создавать предварительные файлы, а создавать доки автоматически из исходников с комментами?

Буду благодарен за любую помощь!

наверно pydoc или попытаться oxigen прикрутить к python

pyr0
создавать доки автоматически из исходников с комментами?

коменты в виде докстрингов ? sphinx умеет такое
пример результата https://flask.readthedocs.org/en/latest/api/

Epydoc is a tool for generating API documentation for Python modules based on their documentation strings (docstrings). A lightweight markup language, called epytext ,can be used to format docstrings and add information about specific fields, such as parameters and instance variables. Epydoc also understands docstrings written in ReStructuredText, Javadoc, and plain text.

pyr0
Подскажите, пожалуйста, софт для автоматической генерации документации. Необходимо примерно следующее: код изначально хорошо закомментирован, потом я запуская софтину (или она сама запускается время от времени) и генерит документации, которую при желании можно подправить. Я смотрел в сторону sphinx, но, на сколько я понял, этот движок генерит доки из изначально подготовленных файлов в специальном формате. В нем есть возможность не создавать предварительные файлы, а создавать доки автоматически из исходников с комментами?Буду благодарен за любую помощь!

Исходя из сказанного прямой путь в sphinx. Да, там нужно бужет немного разобраться как формировать файлы .rst. Но если код хорошо документирован, то там нужно будет прописать инструкции в файлах .rst по минимуму! Делал подобное, кое где делал вставки кода… Буквально за день внимательного чтения и проб можно осилить документирование, а потом радоваться автоматизации =)

Если что, могу подсказать…

Отредактировано buddha (Янв. 13, 2014 12:24:55)