Как выбрать автоматический генератор документации?

Хочу попробовать использовать генератор документации типа Sphinx (sphinx-doc.org) в большом новом проекте. Проект будет на Flask+Angular, с открытым API. Документацию хочется иметь не только для API, но и для javascript'овой части проекта. Поделитесь опытом - кто что использовал для генерации доков?
  • Вопрос задан
  • 2163 просмотра
Пригласить эксперта
Ответы на вопрос 4
@ProstoAndrei
Я бы от себя еще мог порекомендовать ngdocs. Особенно учитывая что у вас angular. Поддерживает по моему почти все что есть в jsdoc. У себя настраивал генерация документации через gulp.
Ответ написан
balamut108
@balamut108
Blockchain Developer
Добрый день, при выборе подобных технологий надо руководствоваться, тем что, если что-то заглючит сможете ли Вы сами это поправить или попросить помощи у сообщества. Кто бы не ругал Сфинкс за его косяки с кириллицей и т.п., как мне кажется у Сфинкса самое большое сообщество, тем более что он более всего известен в нашей среде. + надо понимать, что через N-лет что-то может умереть, а я думаю, что Сфинкс ещё 3-5 лет протянет.
Ответ написан
nikolay_karelin
@nikolay_karelin
Ведущий разработчик, пишу на Python, Tcl, Matlab
Советую посмотреть в сторону понятия доменов в Sphinx. В частности, есть такой пост: https://blog.safaribooksonline.com/2013/04/23/docu...
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы