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

Question

[zasqer]

Хочу попробовать использовать генератор документации типа Sphinx (sphinx-doc.org) в большом новом проекте. Проект будет на Flask+Angular, с открытым API. Документацию хочется иметь не только для API, но и для javascript'овой части проекта. Поделитесь опытом - кто что использовал для генерации доков?

Answer 1

[ProstoAndrei]

Я бы от себя еще мог порекомендовать ngdocs. Особенно учитывая что у вас angular. Поддерживает по моему почти все что есть в jsdoc. У себя настраивал генерация документации через gulp.

Answer 2

[xfg]

Использовал это usejsdoc.org

Comments

[hellboy1981]

Я бы посоветовал YUIDoc

Answer 3

[Vov Vov]

Добрый день, при выборе подобных технологий надо руководствоваться, тем что, если что-то заглючит сможете ли Вы сами это поправить или попросить помощи у сообщества. Кто бы не ругал Сфинкс за его косяки с кириллицей и т.п., как мне кажется у Сфинкса самое большое сообщество, тем более что он более всего известен в нашей среде. + надо понимать, что через N-лет что-то может умереть, а я думаю, что Сфинкс ещё 3-5 лет протянет.

Answer 4

[Николай Карелин]

Советую посмотреть в сторону понятия доменов в Sphinx. В частности, есть такой пост: https://blog.safaribooksonline.com/2013/04/23/docu...