Docco is a literate-programming-style documentation generator, which can produce visually appealing and fantastically useful documentation, just that for the backbone.js source code and Docco's own project website.
Whilst its a snap to setup on *nix systems, you may find a Windows installation a little more taxing. Here is a step-by-step guide to get Docco running on Windows in no time at
NODE_PATH- pointing to its location (on 64-bit systems, this should be
C:\Program Files (x86)\nodejs).
PYTHON_PATH- pointing to its location (this should be at
C:\Python[Version]- in my case Python27).
;C:\Python27;C:\Python27\Scripts(where C:\Python27 matches your PYTHON_PATH value in step 5).
C:\Program Files (x86)\nodejs\node_modules\coffee-script\(C:\Program Files... on non 64-bit systems).
C:\Program Files (x86)\nodejs\node_modules\docco\
python setup.py install
C:\Program Files (x86)\nodejsand paste in the following:
@echo off node.exe %~dp0.\node_modules\coffee-script\bin\coffee %*
@echo off node.exe %~dp0.\node_modules\docco\bin\docco %*
docco filetodocument.js to create documentation. Docco will place the generated documentation in a relative path of
Note, if you're installing on a build machine of some kind, I recommended that you restart the machine in order to ensure that all services pick up the adjusted PATH variable.