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

History

Min RK d2335ab000 handle missing data, metadata in validate_mimebundle		2015-01-04 12:06:23 -08:00
..
auth	address review in custom auth	2014-12-08 10:51:14 -08:00
base	use gen.Return for Python 2	2014-12-16 21:20:09 -08:00
edit	Rename texteditor files & folders to edit	2014-11-25 10:07:52 -08:00
files	Rename get_model() to get()	2014-11-11 14:51:21 -08:00
kernelspecs	Fix HEAD requests for kernelspec resources	2014-12-17 10:40:55 -08:00
nbconvert	Add the . into file_extension	2014-11-20 17:34:39 -08:00
notebook	address review in contents service	2014-11-10 14:02:21 -08:00
services	update kernelspec test	2014-12-30 13:23:05 -08:00
static	handle missing data, metadata in validate_mimebundle	2015-01-04 12:06:23 -08:00
templates	Merge pull request #7327 from minrk/kernel-links	2015-01-01 11:04:50 +01:00
terminal	Merge pull request #6886 from minrk/tornado-4	2014-11-13 12:23:32 -08:00
tests	Some code cleanup in javascript and python	2014-12-27 21:39:07 +01:00
tree	fix clientside notebook manager and assume tree is dir by default	2014-11-19 11:52:03 +01:00
widgets	Remove the popup widget	2014-12-29 08:08:20 -08:00
__init__.py	DOC: Fix typo in comment.	2014-11-06 14:59:44 -05:00
__main__.py
allow76.py	Websockets were not started correctly on QtWebKit 4	2014-11-15 19:26:06 -05:00
log.py
nbextensions.py	Use os.remove instead of shutil.rmtree if we try to remove a symbolic link	2014-11-19 04:46:13 -05:00
notebookapp.py	DEV: Tweaks to Login/LogoutHandler setup.	2014-12-19 00:52:21 -05:00
README.md	use invoke instead of fabric	2014-10-15 16:53:07 -07:00
tasks.py	friendlier error messages when invoke/lessc are missing	2014-12-27 00:16:28 -08:00
utils.py	handle various permission failures	2014-11-19 19:56:52 -08:00

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.