IPython/frontend/html/notebook/static/js/README.md

Documentation
=============

How to Build/ view the doc for javascript.

Javascript documentation should follow a style close to JSDoc one, so you
should be able to build them with your favorite documentation builder.

Still the documentation comment are mainly written to be read with YUI doc. 

You can either build a static version, or start a YUIdoc server that will live
update the doc at every page request. 

To do so, you will need to install YUIdoc.

## Install NodeJS

Node is a browser less javascript interpreter. To install it please refer to
the documentation for your platform. Install also NPM (node package manager) if
it does not come bundled with it.  

## Get YUIdoc

npm does by default install package in `./node_modules` instead of doing a
system wide install. I'll leave you to yuidoc docs if you want to make a system
wide install.

First, cd into js directory :
```bash
cd IPython/frontend/html/notebook/static/js/
# install yuidoc
npm install yuidoc
```


## Run YUIdoc server

From IPython/frontend/html/notebook/static/js/
```bash
# run yuidoc for install dir 
./node_modules/yuidocjs/lib/cli.js --server .
```

Follow the instruction and the documentation should be available on localhost:3000

Omitting `--server` will build a static version in the `out` folder by default.