search

MateusZitelli / js-tree-algorithms

GNU General Public License v3.0
1 stars 0 forks source link

Docco for automatic code documentation #4

Closed cirocosta closed 10 years ago

cirocosta commented 10 years ago

I like a bunch docco for generating documentation. It provides a very clean way of presenting it and it is a lot direct to write (and keep it up to date). It also integrates easily with the build process (see gulp-docco)

An example of docco-generated docs is http://facebook.github.io/rebound-js/docs/rebound.html

Docco ScreenShot

cirocosta commented 10 years ago

What do you think @MateusZitelli ? Any other proposal?

MateusZitelli commented 10 years ago

Nice @cirocosta, I like the docco style of documentation and think that will fit nicely to explain the algorithms.

cirocosta commented 10 years ago

:+1: i'll check the documentation later and then apply to what i've done so far

cirocosta commented 10 years ago

deploy.sh is somewhat messed up so i reopenned the issue to remind us of that. I also the npm's deploy script field so that our tests don't get confused because of a fail in the deploy process