Посоветуйте сервис генерации документации для Python

#python #документация

Мне понадобилось написать документацию для API, написанного на базе Python (cherrypy).
Хотелось бы максимально автоматизировать процесс, например добавить комментарий с
тэгом к функции, чтобы сервис сам собрал все функции и их параметры из файла в справочный
html файл.
Есть ли такой сервис?
Очень не хочется заниматься тупым копированием.
    

Ответы

Ответ 1

Широкоиспользуемой библиотекой для генерации документации является Sphinx—как CPython
так и многие Питон библиотеки её используют.

Sphinx autodoc расширение может генерировать документацию из docstrings. Могут быть
использованы различные форматы, к примеру numpydoc позволяет autodoc распознавать специфичный
для numpy формат документации, используемой в docstrings.

Для быстрого просмотра документации, сохранённой в docstring, можно использовать
pydoc модуль/команду из стандартной библиотеки. Встроенная help() использует pydoc
для генерации текстовой документации для просмотра в консоли.

Примеры других инструментов по генерации документации для проектов написанных на
Питоне, можно в вики посмотреть.


Ответ 2

Один из самых распространенных инструментов для автогенерирования API документации
называется swagger.
При желании вместе с функциональностью "сделай мне документ по описанию API" можно
использовать целую экосистему open-source инструментов, так или иначе облегчающих работу
с вашим API.

Не знаю насколько он популярен среди питонистов, но с питоном работать тоже умеет.


Ответ 3

Я использовал apidoc достаточно просто, быстро. Вот страничка