mirror of https://github.com/jupyter/notebook.git synced 2025-01-18 11:55:46 +08:00

History

Adam Hodgen c695ba45bc Remove / from route of TreeRedirectHandler. When base_url is set, navigating to http://{url}/{base_url} returns 404 This is due to the TreeRedirectHandler only picking up http://{url}/{base_url}/ and the trailing slash handler being set to {base_url}/.*/. This change will cause http://{url}/{base_url} to correctly redirect to http://{url}/{base_url}/tree, as expected.		2014-07-11 20:48:42 +01:00
..
auth
base	s/cors_/allow_/	2014-06-30 10:40:31 -07:00
kernelspecs	Kernel resource handlers now require authenticated user	2014-06-16 15:24:30 -07:00
nbconvert	Remove unused imports	2014-05-01 15:42:46 -07:00
notebook	better log message in deprecated files/ redirect	2014-03-20 14:38:44 -07:00
services	don’t import IPython.parallel until it’s used	2014-06-24 15:53:27 -07:00
static	Updated custom.js template to reflect IPython namespace changes	2014-07-10 15:47:23 -05:00
templates	More requirejs fixes	2014-07-10 15:47:23 -05:00
tests	More requirejs fixes	2014-07-10 15:47:23 -05:00
tree	Remove / from route of TreeRedirectHandler.	2014-07-11 20:48:42 +01:00
widgets	Fixed buggy behavior	2014-07-08 10:57:56 -05:00
__init__.py
__main__.py
fabfile.py	add instruction to pin lessc	2014-06-13 21:56:39 +02:00
log.py
nbextensions.py	add utils.path.ensure_dir_exists	2014-04-29 10:18:36 -07:00
notebookapp.py	only set allow_origin_pat if defined	2014-07-09 16:25:36 -05:00
README.md
utils.py	only check listdir on dirs	2014-03-20 14:40:39 -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 committed into our git repo. Our dependencies are described in the file static/components/bower.json. To update our bower packages, run fab update 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.