lluminy

светящийся Автоматическая документация для проектов на Python

lluminy — это инструмент на базе ИИ, предназначенный для автоматического создания и поддержания документации для кодовых баз Python. Основное внимание уделяется обогащению кода докстрингами, полученными из существующего кода и комментариев, без изменения исходной логики. Решение интегрируется непосредственно с GitHub для оптимизации документации в репозиториях, что делает бортовое обслуживание, обслуживание и сотрудничество более эффективными.

Ключевое значение

• Экономьте время на документацию, генерируя докстринги для целых кодовых баз в течение нескольких минут.
• Сохранить целостность исходного кода, работая исключительно на докстрингах и избегая модификации кода.
• Улучшить работу разработчиков и текущее обслуживание с хорошо документированными функциями и модулями.
• Бесшовно вписывается в существующие рабочие процессы посредством интеграции GitHub и публикации на основе запросов.

Как это работает

1. Подключите учетную запись GitHub и выберите репозитории.
2. Сгенерировать документацию для всей кодовой базы или для конкретных файлов/отраслей.
3. Выберите документировать все функции или только те, которые отсутствуют.
4. Опубликуйте результаты, создав запрос на вытягивание с генерируемыми докстрингами.

Примечания:

• Докстринги генерируются без изменения основного кода, снижая риск галлюцинаций LLM, влияющих на поведение.
• Работает с несколькими файлами и целыми проектами, масштабируемыми от небольших до больших кодовых баз.

Особенности

• Генерация docstring на базе ИИ для кода Python
• Документация для целых кодовых баз или выборочных файлов/каталогов/филиалов
• Возможность документировать все функции или только те, которые отсутствуют
• Интеграция GitHub для выбора хранилища и создания запросов
• Создание запросов на вытягивание с изменениями документации автоматически
• Никаких изменений исходной кодовой базы; документация добавляется только в виде докстрингов
• Поддержка многофайловых и многопроектных рабочих процессов
• Подходит для посадки, обслуживания и сотрудничества между командами

Как использовать lluminy

1. Подключить GitHubСвяжите свою учетную запись GitHub и авторизуйте доступ.
2. Выберите репозиторииВыберите, какие хранилища или филиалы документировать.
3. Конфигурация ScopeРешите задокументировать все функции или только те, которые отсутствуют.
4. Генерировать и публиковатьСоздайте докстринги и создайте запрос на вытягивание с результатами.

Цены

• Попробуйте: бесплатный план с ограниченным использованием токенов AI
• Премиум: для команд и производственных кодовых баз по 20 долларов в месяц с лимитом токенов AI 10 миллионов в месяц

Зачем использовать светильник

• Автоматизация повторяющихся задач документации для ускорения посадки и обслуживания
• Сохраняет кодовую базу неизменной, предоставляя полную и доступную документацию
• Интегрируется с GitHub для оптимизации сотрудничества и PR-публикации

Основные характеристики

• Генерация документации на базе LLama3.3
• Docstrings для всей кодовой базы или выбранных файлов / ветвей
• Интеграция GitHub для выбора хранилища и создания PR
• Документируйте все функции или только те, которые отсутствуют
• Автоматизированное создание запроса на вытягивание для публикации документации
• Работает как с личными, так и с организационными репозиториями