Python-сообщество

Приветствую.

Хочу поделиться с вами проектом и услышать ваше мнение о нем. Может быть чего-то не хватает? Может быть вы видите его как-то иначе? А может быть вы хотели бы присоединиться к разработке вместе со мной 🙂

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

• Python
  
• FastAPI
  
• JavaScript
  

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

• gen - Генерация Markdown файлов документации.
  
• build - Генерация Markdown файлов документации с последующей сборкой в static HTML.
  
• serve - Запускает сервер с помощью FastAPI и uvicorn, для self-host документации.
  
• tmpl-new - Создает новый шаблон для документации
  
• tmpl-list - Возвращает список имен сохраненных шаблонов
  

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

Какие у проекта зависимости? Чем он лучше Doxygen-а, Sphinx-а, Epydoc-а и прочих?

Rodegast
Какие у проекта зависимости?

Зависимости проекта можно просмотреть в setup.py, но вот их список:

• FastAPI
  
• Uvicorn
  
• Jinja2
  
• Click
  

Rodegast
Чем он лучше Doxygen-а, Sphinx-а, Epydoc-а и прочих?

Не могу претендовать на то, что сейчас - проект лучше выше сказанных, однако хочу сделать возможным генерацию документации для любого типа проектов, например у разработчика есть две папки backend и frontend, и одной командой можно было бы генерировать документацию для обоих проектов. То есть необязательно концентрироваться на каком-то одном стеке - будет возможность сделать документацию для любого стека.

Кастомизируемые шаблоны - юзер может запросто взять и написать собственный шаблон, если стандартный его не устраивает (в дефолтной теме присутствуют night/light тема, sidebar, navigation links, etc)

Добавлю, что в будущем я собираюсь добавить runnableExamples, которые будут запускаться перед генерацией документации.

> Зависимости проекта можно просмотреть в setup.py

Они должны быть в requirements.txt

> autodoc CLI tool written in Python

Если это CLI, то зачем тогда FastAPI и Uvicorn нужны?

Rodegast
Они должны быть в requirements.txt

Насколько мне известно - применяется либо setup.py, либо requirements.txt

Rodegast
Если это CLI, то зачем тогда FastAPI и Uvicorn нужны?

эти библиотеки нужны для команды serve для self-host документации