apidescribed для mkdocs на Python

Плагин к mkdocs для генерации документации API в приложениях на Python

Репозиторий: https://github.com/idlesign/mkdocs-apidescribed-plugin Автор: Игорь Стариков

Это подключаемое приложение для MkDocs

позволяет генерировать документацию к программным интерфейсам ваших приложений автоматически
сочетается с Material для MkDocs
конфигуриуемо
просто в использовании

Зачастую достаточно добавить директиву ::: apidescribed: в ваш .md файл на желаемое место.
За директивной должен следовать «путь» к модулю (в примере ниже это модуль somemodule из пакета somepackage):

    Это моя документация. Текст до автоописания.
    
    ::: apidescribed: somepackage.somemodule
    
    Текст после автоописания.

Примеры сгенерированной документации:

ВКонтакте 0

Категории

На заметку

В разделе «События» можно узнать о надвигающихся событиях мира Python, а также поделиться своими. Если вы являетесь организатором встречи/конференции/спринта, зарегистрируйте это событие в указанном разделе, чтобы о нём узнали все желающие.