History

Min RK 81f8cfeccb cleanup some html services tests		11 years ago
..
auth	Not critical, and more color as warning is orange	11 years ago
base	Merge pull request #7798 from jasongrout/buffer-memoryview	11 years ago
edit	Rename texteditor files & folders to edit	11 years ago
files	get mime from filename	11 years ago
kernelspecs	Fix HEAD requests for kernelspec resources	11 years ago
nbconvert	removing spurious import	11 years ago
notebook	make FilesRedirectHandler redirect logic accessible	11 years ago
services	cleanup some html services tests	11 years ago
static	Merge pull request #7757 from jasongrout/custom-serialization	11 years ago
templates	Add tooltip on the upload button.	11 years ago
terminal	require terminado >= 0.3.3 for terminal handlers	11 years ago
tests	Merge pull request #7757 from jasongrout/custom-serialization	11 years ago
tree	fix clientside notebook manager and assume tree is dir by default	11 years ago
widgets	Merge pull request #7757 from jasongrout/custom-serialization	11 years ago
README.md	use invoke instead of fabric	11 years ago
__init__.py	DOC: Fix typo in comment.	11 years ago
__main__.py	add `python -m` entry points for everything	12 years ago
allow76.py	Websockets were not started correctly on QtWebKit 4	11 years ago
log.py	minor notebook logging changes	12 years ago
nbextensions.py	minor doc improvement on nbextension	11 years ago
notebookapp.py	pass kernel_spec_manager down from NotebookApp	11 years ago
tasks.py	friendlier error messages when invoke/lessc are missing	11 years ago
utils.py	escaped URLs are always utf-8	11 years ago

README.md

IPython Notebook development

Development dependencies

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

invoke
node.js
less (npm install -g less)

Components

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

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 python setup.py css from the root of the repository. If you are working frequently with .less files please consider installing git hooks that rebuild the css files and corresponding maps in ${RepoRoot}/git-hooks/install-hooks.sh.

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.