Repolode
Предложить
ml-tooling

ml-tooling/lazydocs

CLI-утилита, которая генерирует Markdown-документацию API по Python-докстрингам в стиле Google и служит более лёгкой альтернативой Sphinx.

Открыть на GitHub
Звёзды
253
Форки
42
Открытые issues
3
Последний коммит
15 дней назад

Что это?

Lazydocs сканирует Python-пакет, модуль или указанные классы и функции, а затем создаёт Markdown-документацию на основе их докстрингов в стиле Google. Утилиту можно запустить одной командой из CLI или вызвать из Python через программный API. По умолчанию файлы сохраняются в папку ./docs; также документацию можно вывести в stdout.

Сгенерированные файлы корректно отображаются в Markdown-рендерере GitHub и могут быть включены в сайт на MkDocs. Для каждого модуля, класса, метода и функции можно добавить ссылку на исходный файл и номер строки — с относительным путём или настраиваемым базовым URL. В отдельном обзорном файле можно перечислить все модули, классы и функции.

При желании перед генерацией можно проверять докстринги с помощью pydocstyle; если найдутся проблемы, генерация остановится. Другие параметры позволяют включать приватные модули, добавлять оглавление и временную метку, а также выбирать формат вывода md или mdx.

Ключевые возможности

  • 01Генерирует Markdown-документацию API по Python-докстрингам в стиле Google.
  • 02Создаёт ссылки на исходный код с путями к файлам и номерами строк.
  • 03Создаёт обзорный файл API со списком модулей, классов и функций.
  • 04Интегрируется с сайтами на MkDocs и Markdown-рендерером GitHub.
  • 05При необходимости проверяет докстринги с помощью pydocstyle перед генерацией.

Сценарии использования

  • Публикация справочной документации API Python-библиотеки рядом с её репозиторием на GitHub.
  • Добавление автоматически сгенерированного раздела API Reference на сайт документации MkDocs.
  • Вывод документации по докстрингам в консоль во время работы над модулем.

Быстрый старт

  1. 1

    Установите lazydocs из PyPI

    pip install lazydocs
  2. 2

    Создайте документацию в Markdown для своего пакета Python

    lazydocs path/to/your/package

Что важно знать

  • Поддерживаются только Python docstring в стиле Google.

В подборках

Генераторы статических сайтов и инструменты для документации

Темы

#python#documentation#api-docs#markdown#docstring#mkdocs#google-style#api-docs-generator#pydoc#python-api

Частые вопросы

Что такое lazydocs?
CLI-утилита, которая генерирует Markdown-документацию API по Python-докстрингам в стиле Google и служит более лёгкой альтернативой Sphinx. Lazydocs сканирует Python-пакет, модуль или указанные классы и функции, а затем создаёт Markdown-документацию на основе их докстрингов в стиле Google. Утилиту можно запустить одной командой из CLI или вызвать из Python через программный API. По умолчанию файлы сохраняются в папку ./docs; также документацию можно вывести в stdout.
lazydocs можно использовать бесплатно? Какая у него лицензия?
lazydocs распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
lazydocs всё ещё поддерживается?
Активно поддерживается. Последний коммит в lazydocs — 23 окт. 2026 г..
Для чего можно использовать lazydocs?
Публикация справочной документации API Python-библиотеки рядом с её репозиторием на GitHub. Добавление автоматически сгенерированного раздела API Reference на сайт документации MkDocs. Вывод документации по докстрингам в консоль во время работы над модулем.
Как установить lazydocs?
Установите lazydocs из PyPI: pip install lazydocs Создайте документацию в Markdown для своего пакета Python: lazydocs path/to/your/package
Где скачать lazydocs?
Исходный код и инструкции по установке — на GitHub: https://github.com/ml-tooling/lazydocs

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты