##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Refactor part for "%run -d"
Takafumi Arakaki -
r10004:2975de6a
Show More
Name Size Modified Last Commit Author
/ IPython / frontend / html / notebook / static / js
celltoolbarpresets
README.md 1.3 KiB 
r8721:ff5b09e6187e
Matthias BUSSONNIER
cell.js 9.8 KiB 
r9698:48c19e7b78e2
Bussonnier Matthias
celltoolbar.js 13.3 KiB 
r9462:83b41e4c4b24
Matthias BUSSONNIER
clusterlist.js 6.6 KiB 
r9699:21b391208884
Matthias BUSSONNIER
codecell.js 14.3 KiB 
r9695:98972ec30fd8
Bussonnier Matthias
completer.js 9.9 KiB 
r9221:e5ad923ff553
Brian E. Granger
config.js 2.6 KiB 
r8949:77fe6f1fbba5
Bussonnier Matthias
contexthint.js 2.9 KiB 
r7196:b0be2d037672
Matthias BUSSONNIER
custom.js 1.6 KiB 
r9083:bc2f76f14594
Matthias BUSSONNIER
events.js 1.0 KiB 
r7168:cf8312283725
Brian Granger
kernel.js 14.7 KiB 
r9412:d72667c043fc
MinRK
layoutmanager.js 2.1 KiB 
r9265:45c3a2ef0681
Bussonnier Matthias
loginmain.js 785 B 
r9265:45c3a2ef0681
Bussonnier Matthias
loginwidget.js 1.5 KiB 
r9503:b9a51293349a
Bussonnier Matthias
logoutmain.js 708 B 
r9265:45c3a2ef0681
Bussonnier Matthias
maintoolbar.js 7.8 KiB 
r9160:91fe08918c06
Brian Granger
mathjaxutils.js 9.6 KiB 
r8662:87b7b8a5cd34
Aron Ahmadia
menubar.js 8.7 KiB 
r9699:21b391208884
Matthias BUSSONNIER
namespace.js 833 B 
r5479:0168dc2190d9
Stefan van der Walt
notebook.js 49.7 KiB 
r9816:c851d066b5dd
Matthias BUSSONNIER
notebooklist.js 11.6 KiB 
r9787:510b1670524a
Matthias BUSSONNIER
notebookmain.js 3.7 KiB 
r9505:cd7593c16c57
Matthias BUSSONNIER
notificationarea.js 6.8 KiB 
r9228:eff2cedef466
Brian E. Granger
notificationwidget.js 2.6 KiB 
r8206:567c002e58fa
Matthias BUSSONNIER
outputarea.js 18.5 KiB 
r9903:731a7d908412
Harry Moreno
page.js 1.8 KiB 
r9381:304133c8030e
Matthias BUSSONNIER
pagemain.js 640 B 
r6192:a53b1a9f3987
Brian Granger
pager.js 5.5 KiB 
r9488:91b3604d31c1
Matthias BUSSONNIER
printnotebookmain.js 1.1 KiB 
r9277:3a70b9dfb570
Bussonnier Matthias
projectdashboardmain.js 2.7 KiB 
r9265:45c3a2ef0681
Bussonnier Matthias
quickhelp.js 3.0 KiB 
r8692:2b7844740a79
David Warde-Farley
savewidget.js 4.8 KiB 
r9909:85906fa6c061
Olivier Verdier
textcell.js 16.3 KiB 
r9537:87e41d123f80
Matthias BUSSONNIER
toolbar.js 3.4 KiB 
r9542:4f23a77838dc
Matthias BUSSONNIER
tooltip.js 12.7 KiB 
r9228:eff2cedef466
Brian E. Granger
utils.js 11.4 KiB 
r9227:2bdb4e24adc9
Brian E. Granger

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 :

cd IPython/frontend/html/notebook/static/js/
# install yuidoc
npm install yuidoc

Run YUIdoc server

From IPython/frontend/html/notebook/static/js/

# 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.