p6micgy9w
/
monkeyking
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '112c4083e9'
${ noResults }
monkeyking/IPython/html
History
MinRK 112c4083e9
add comments for style blocks in less 		12 years ago
..
auth s/base_project_url/base_url/ 12 years ago
base Only allow iframe embedding on same origin. 12 years ago
kernelspecs Kernel resource handlers now require authenticated user 12 years ago
nbconvert Remove unused imports 12 years ago
notebook better log message in deprecated files/ redirect 12 years ago
services Only allow iframe embedding on same origin. 12 years ago
static add comments for style blocks in less 12 years ago
templates More requirejs fixes 12 years ago
tests Delete session rather than killing kernel in test cleanup 12 years ago
tree Remove / from route of TreeRedirectHandler. 12 years ago
widgets Fixed buggy behavior 12 years ago
README.md correct instructions for updating components 12 years ago
__init__.py add install_nbextension at top-level IPython.html 12 years ago
__main__.py add `python -m` entry points for everything 12 years ago
fabfile.py Upgrade less and generate sourcemap files 12 years ago
log.py minor notebook logging changes 12 years ago
nbextensions.py add utils.path.ensure_dir_exists 12 years ago
notebookapp.py remove rackcdn https workaround for mathjax cdn 12 years ago
utils.py only check listdir on dirs 12 years ago

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.