Z
Z
zasqer2015-06-28 15:38:58
Python
zasqer, 2015-06-28 15:38:58

How to choose an automatic documentation generator?

I want to try using the Sphinx type documentation generator ( sphinx-doc.org ) on a big new project. The project will be on Flask + Angular, with an open API. I would like to have documentation not only for the API, but also for the javascript part of the project. Share your experience - who used what to generate docks?

Answer the question

In order to leave comments, you need to log in

4 answer(s)
P
ProstoAndrei, 2015-07-02
@ProstoAndrei

I would also recommend ngdocs on my own. Especially considering that you have angular. In my opinion, it supports almost everything that is in jsdoc. I set up documentation generation via gulp.

X
xfg, 2015-06-29
@xfg

Used this usejsdoc.org

V
Vov Vov, 2015-06-29
@balamut108

Good afternoon, when choosing such technologies, one should be guided by the fact that if something fails, can you fix it yourself or ask for help from the community. Whoever scolds the Sphinx for its jambs with Cyrillic, etc., it seems to me that the Sphinx has the largest community, especially since it is most famous in our environment. + you need to understand that in N-years something can die, but I think that the Sphinx will last another 3-5 years.

N
Nikolai Karelin, 2015-07-02
@nikolay_karelin

I advise you to look towards the concept of domains in Sphinx. In particular, there is this post: https://blog.safaribooksonline.com/2013/04/23/docu...

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question