upstream/ipython Files · IPython/html/README.md

Fix constructor comments...

Fix constructor comments Add content_manager as a dictionary key to the options param passed in to the NotebookList and Notebook constructors.

MinRK - - Load All Authors

File last commit:

r18351:0ab76370


                r18631:c0331d87

Download file

             README.md
        
                    70 lines
            
             | 2.2 KiB
            
                | text/x-minidsrc
            
             |
                MarkdownLexer
            
             / IPython / html / README.md
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Brian E. Granger
    
Adding README.md about notebook development.

              r10439
            
      # IPython Notebook development

        Brian E. Granger
    
Reorg of the js/less/css files.

              r10697
            
      ## Development dependencies

        Brian E. Granger
    
Adding README.md about notebook development.

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

        MinRK
    
use invoke instead of fabric...

              r18351
            
      * invoke

        Brian E. Granger
    
Adding README.md about notebook development.

              r10439
            
      * node.js

      * less (`npm install -g less`)

        Brian E. Granger
    
Reorg of the js/less/css files.

              r10697
            
      ## Components

        Brian E. Granger
    
Adding README.md about notebook development.

              r10439
            
      We are moving to a model where our JavaScript dependencies are managed using 

      [bower](http://bower.io/). These packages are installed in `static/components`

        Matthias BUSSONNIER
    
Fix doc, CodeMirror is installed via bower...

              r17453
            
      and committed into a separate git repo [ipython/ipython-components](ipython/ipython-components).

      Our dependencies are described in the file

        MinRK
    
use invoke instead of fabric...

              r18351
            
      `static/components/bower.json`. To update our bower packages, run `bower install`

        Paul Ivanov
    
correct instructions for updating components

              r15579
            
      in this directory.

        Brian E. Granger
    
Adding README.md about notebook development.

              r10439
            
        Brian E. Granger
    
Reorg of the js/less/css files.

              r10697
            
      ## less

        Brian E. Granger
    
Adding README.md about notebook development.

              r10439
            
      If you edit our `.less` files you will need to run the less compiler to build

        MinRK
    
use invoke instead of fabric...

              r18351
            
      our minified css files.  This can be done by running `python setup.py css` from the root of the repository. 

        Matthias BUSSONNIER
    
Fix doc, CodeMirror is installed via bower...

              r17453
            
      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`.

        Brian E. Granger
    
Adding README.md about notebook development.

              r10439
            
        Brian E. Granger
    
Reorg of the js/less/css files.

              r10697
            
      ## 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 :

      ```bash

        MinRK
    
update references for IPython.html

              r11035
            
      cd IPython/html/static/js/

        Brian E. Granger
    
Reorg of the js/less/css files.

              r10697
            
      # install yuidoc

      npm install yuidocjs

      ```

      ### Run YUIdoc server

        MinRK
    
update references for IPython.html

              r11035
            
      From IPython/html/static/js/

        Brian E. Granger
    
Reorg of the js/less/css files.

              r10697
            
      ```bash

      # run yuidoc for install dir 

      ./node_modules/yuidocjs/lib/cli.js --server .

      ```

      Follow the instruction and the documentation should be available on localhost:3000

        Fernando Perez
    
Fix all remaining imports that used `IPython.frontend`.

              r11024
            
      Omitting `--server` will build a static version in the `out` folder by default.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Brian E. Granger Adding README.md about notebook development.	r10439	# IPython Notebook development

Brian E. Granger Reorg of the js/less/css files.	r10697	## Development dependencies
Brian E. Granger Adding README.md about notebook development.	r10439
		Developers of the IPython Notebook will need to install the following tools:

MinRK use invoke instead of fabric...	r18351	* invoke
Brian E. Granger Adding README.md about notebook development.	r10439	* node.js
		* less (`npm install -g less`)

Brian E. Granger Reorg of the js/less/css files.	r10697	## Components
Brian E. Granger Adding README.md about notebook development.	r10439
		We are moving to a model where our JavaScript dependencies are managed using
		[bower](http://bower.io/). These packages are installed in `static/components`
Matthias BUSSONNIER Fix doc, CodeMirror is installed via bower...	r17453	and committed into a separate git repo [ipython/ipython-components](ipython/ipython-components).
		Our dependencies are described in the file
MinRK use invoke instead of fabric...	r18351	`static/components/bower.json`. To update our bower packages, run `bower install`
Paul Ivanov correct instructions for updating components	r15579	in this directory.
Brian E. Granger Adding README.md about notebook development.	r10439
Brian E. Granger Reorg of the js/less/css files.	r10697	## less
Brian E. Granger Adding README.md about notebook development.	r10439
		If you edit our `.less` files you will need to run the less compiler to build
MinRK use invoke instead of fabric...	r18351	our minified css files. This can be done by running `python setup.py css` from the root of the repository.
Matthias BUSSONNIER Fix doc, CodeMirror is installed via bower...	r17453	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`.
Brian E. Granger Adding README.md about notebook development.	r10439
Brian E. Granger Reorg of the js/less/css files.	r10697	## 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 :
		```bash
MinRK update references for IPython.html	r11035	cd IPython/html/static/js/
Brian E. Granger Reorg of the js/less/css files.	r10697	# install yuidoc
		npm install yuidocjs
		```


		### Run YUIdoc server

MinRK update references for IPython.html	r11035	From IPython/html/static/js/
Brian E. Granger Reorg of the js/less/css files.	r10697	```bash
		# run yuidoc for install dir
		./node_modules/yuidocjs/lib/cli.js --server .
		```

		Follow the instruction and the documentation should be available on localhost:3000

Fernando Perez Fix all remaining imports that used `IPython.frontend`.	r11024	Omitting `--server` will build a static version in the `out` folder by default.