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

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

define `__file__` in config files
MinRK -
r10646:d8393e88
Show More
Name Size Modified Last Commit Author
/ IPython / frontend / html / notebook / static / js
celltoolbarpresets
README.md 1.3 KiB 
r10034:27941715371a
David Wyde
cell.js 9.4 KiB 
r10453:3cf26cde5e3e
Brian E. Granger
celltoolbar.js 13.3 KiB 
r9462:83b41e4c4b24
Matthias BUSSONNIER
clusterlist.js 6.6 KiB 
r9989:9d8f250b3214
MinRK
codecell.js 14.6 KiB 
r10418:a0c4e41160c0
Brian E. Granger
codemirror-ipython.js 12.2 KiB 
r10416:22418c901264
Brian E. Granger
completer.js 10.2 KiB 
r10486:654d1129ecab
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 16.5 KiB 
r10615:6d687c6b60a1
Matthias Bussonnier
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 
r10513:156594a742c8
MinRK
mathjaxutils.js 9.6 KiB 
r8662:87b7b8a5cd34
Aron Ahmadia
menubar.js 9.9 KiB 
r10520:0c16365c7928
MinRK
namespace.js 833 B 
r5479:0168dc2190d9
Stefan van der Walt
notebook.js 68.7 KiB 
r10600:973dad6c1277
Brian E. Granger
notebooklist.js 11.6 KiB 
r9787:510b1670524a
Matthias BUSSONNIER
notebookmain.js 4.5 KiB 
r10549:044203b9718c
MinRK
notificationarea.js 8.3 KiB 
r10505:757bf961c637
MinRK
notificationwidget.js 2.6 KiB 
r8206:567c002e58fa
Matthias BUSSONNIER
outputarea.js 20.8 KiB 
r10445:a6cc6c4acbff
MinRK
page.js 1.8 KiB 
r9381:304133c8030e
Matthias BUSSONNIER
pagemain.js 640 B 
r6192:a53b1a9f3987
Brian Granger
pager.js 6.0 KiB 
r10474:1a1e6e5261c0
Erik Tollerud
projectdashboardmain.js 2.7 KiB 
r9265:45c3a2ef0681
Bussonnier Matthias
quickhelp.js 3.0 KiB 
r8692:2b7844740a79
David Warde-Farley
savewidget.js 5.6 KiB 
r10547:2e981b8bea30
MinRK
textcell.js 15.6 KiB 
r10539:d7ab51b3d0eb
MinRK
toolbar.js 3.4 KiB 
r9542:4f23a77838dc
Matthias BUSSONNIER
tooltip.js 12.6 KiB 
r10425:198b5d5513f2
Brian E. Granger
utils.js 10.7 KiB 
r10453:3cf26cde5e3e
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 yuidocjs

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.