28

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

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

  • Python

  • FastAPI

  • JavaScript

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

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

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

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

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

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

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

Правила сообщества

Публиковать могут пользователи с любым рейтингом. Однако!


Приветствуется:

• уважение к читателям и авторам

• конструктивность комментариев

• простота и информативность повествования

• тег python2 или python3, если актуально

• код публиковать в виде цитаты, либо ссылкой на специализированный сайт


Не рекомендуется:

• допускать оскорбления и провокации

• распространять вредоносное ПО

• просить решить вашу полноценную задачу за вас

• нарушать правила Пикабу

Вы смотрите срез комментариев. Показать все
2
Автор поста оценил этот комментарий
Я зашёл посмотреть и не понял нахера это надо. Зачем нужна ещё одна тулза для генерации документации? Зачем нужна какая-то дока для FastAPI кроме OpenAPI которая из коробки работает?

Не хватает примера что в итоге получится
раскрыть ветку (2)
0
Автор поста оценил этот комментарий

Пример можете посмотреть здесь: https://hapticx.github.io/hapdoc/hapdoc/readme.html
Тут всегда актуальная сборка документации.

Зачем это нужно?
1. Вы можете настроить собственный шаблон для документации
2. Возможность генерации документации для проекта любого типа (выбор типа проекта + exclude/include дополнительных типов файлов в проекте). Например проект, содержащий в себе папки frontend и backend, в каждой из которых например  FastAPI и Vue.js3. Одной командой можно будет генерировать документацию для обоих проектов (если конечно этого захочет разработчик).
3. В будущем я попробую добавить runnable examples, которые будут запускаться перед генерацией документации

раскрыть ветку (1)
0
Автор поста оценил этот комментарий

Вёрстка -> огонь))

Думал вообще нихуя не работает, пока не развернул на полный экран)

Иллюстрация к комментарию
Иллюстрация к комментарию
Вы смотрите срез комментариев. Чтобы написать комментарий, перейдите к общему списку

Темы

Политика

Теги

Популярные авторы

Сообщества

18+

Теги

Популярные авторы

Сообщества

Игры

Теги

Популярные авторы

Сообщества

Юмор

Теги

Популярные авторы

Сообщества

Отношения

Теги

Популярные авторы

Сообщества

Здоровье

Теги

Популярные авторы

Сообщества

Путешествия

Теги

Популярные авторы

Сообщества

Спорт

Теги

Популярные авторы

Сообщества

Хобби

Теги

Популярные авторы

Сообщества

Сервис

Теги

Популярные авторы

Сообщества

Природа

Теги

Популярные авторы

Сообщества

Бизнес

Теги

Популярные авторы

Сообщества

Транспорт

Теги

Популярные авторы

Сообщества

Общение

Теги

Популярные авторы

Сообщества

Юриспруденция

Теги

Популярные авторы

Сообщества

Наука

Теги

Популярные авторы

Сообщества

IT

Теги

Популярные авторы

Сообщества

Животные

Теги

Популярные авторы

Сообщества

Кино и сериалы

Теги

Популярные авторы

Сообщества

Экономика

Теги

Популярные авторы

Сообщества

Кулинария

Теги

Популярные авторы

Сообщества

История

Теги

Популярные авторы

Сообщества