mirror of https://github.com/jupyter/notebook.git synced 2024-12-27 04:20:22 +08:00

History

Min RK 003c5e8eda Merge pull request #4971 from ellisonbg/testjs-fd Fixing issues with js tests		2014-01-31 20:38:32 -08:00
..
auth	mv IPython.html.notebook -> IPython.html	2013-06-27 11:14:10 -07:00
base	Handle variations of name for origin	2014-01-24 00:19:59 -06:00
nbconvert	Merge pull request #4735 from minrk/better-errors	2014-01-09 13:03:31 -08:00
notebook	Move notebook URL fragment regexen into IPython.html.base.handlers	2013-12-19 13:01:00 -08:00
services	move signature checking to base NotebookManager	2014-01-29 14:37:00 -08:00
static	Merge pull request #4971 from ellisonbg/testjs-fd	2014-01-31 20:38:32 -08:00
templates	Adding DOM ids for each menu.	2014-01-28 20:30:18 -08:00
tests	Merge pull request #4971 from ellisonbg/testjs-fd	2014-01-31 20:38:32 -08:00
tree	Move notebook URL fragment regexen into IPython.html.base.handlers	2013-12-19 13:01:00 -08:00
widgets	Fix some formatting in widget docstrings	2014-01-29 14:55:12 -08:00
__init__.py	mv IPython.html.notebook -> IPython.html	2013-06-27 11:14:10 -07:00
__main__.py	add `python -m` entry points for everything	2014-01-07 12:32:31 -08:00
fabfile.py	we don't bundle lessc anymore, remove its vestiges	2014-01-13 16:17:50 -08:00
log.py	adjustments to notebook app logging	2014-01-21 10:48:24 -08:00
notebookapp.py	move `ipython notebook trust` to `ipython trust`	2014-01-28 18:44:50 -08:00
README.md	update references for IPython.html	2013-06-27 11:14:10 -07:00
utils.py	Fix imports in IPython.html.utils	2013-10-29 09:15:56 -07:00

README.md

IPython Notebook development

Development dependencies

Developers of the IPython Notebook will need to install the following tools:

fabric
node.js
less (npm install -g less)
bower (npm install -g bower)

Components

We are moving to a model where our JavaScript dependencies are managed using bower. These packages are installed in static/components and commited into our git repo. Our dependencies are described in the file static/bower.json. To update our bower packages, run fab components in this directory.

Because CodeMirror does not use proper semantic versioning for its GitHub tags, we maintain our own fork of CodeMirror that is used with bower. This fork should track the upstream CodeMirror exactly; the only difference is that we are adding semantic versioned tags to our repo.

less

If you edit our .less files you will need to run the less compiler to build our minified css files. This can be done by running fab css from this directory.

JavaScript 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/html/static/js/
# install yuidoc
npm install yuidocjs

Run YUIdoc server

From IPython/html/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.