Найти в Дзене
Пикабу

HapDoc - утилита для генерации документации

Приветствую. Хочу поделиться с вами проектом и услышать ваше мнение о нем. Может быть чего-то не хватает? Может быть вы видите его как-то иначе? А может быть вы хотели бы присоединиться к разработке вместе со мной 🙂 Я разрабатываю утилиту для автоматической генерации документации под названием HapDoc. На данном этапе разработке возможно сгенерировать документацию для 3-х типов проектов:

Python.

FastAPI.

JavaScript.

Основными командами являются:

gen - Генерация Markdown файлов документации.

build - Генерация Markdown файлов документации с последующей сборкой в static HTML.

serve - Запускает сервер с помощью FastAPI и uvicorn, для self-host документации.

tmpl-new - Создает новый шаблон для документации.

tmpl-list - Возвращает список имен сохраненных шаблонов.

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

Пост автора Ethosa.

Комментарии