From 81854d7b8ebe975df95ab4185488f71bfd1e98b1 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Thu, 14 Jun 2012 10:29:50 +0200 Subject: [PATCH] Update --- _sources/index.txt | 86 ++++++++++++++++++++++++++++++++++++++++++++-- index.html | 70 ++++++++++++++++++++++++++++++++++--- searchindex.js | 2 +- 3 files changed, 151 insertions(+), 7 deletions(-) diff --git a/_sources/index.txt b/_sources/index.txt index 59692e8..d4d689b 100644 --- a/_sources/index.txt +++ b/_sources/index.txt @@ -6,6 +6,9 @@ Welcome to Emacs IPython Notebook's documentation! Emacs IPython Notebook (EIN) provides fully featured IPython Notebook client and integrated REPL (like SLIME_). +.. _`Emacs IPython Notebook (EIN)`: + https://github.com/tkf/emacs-ipython-notebook + .. _SLIME: http://common-lisp.net/project/slime/ Highlighted features: @@ -30,12 +33,91 @@ Other notebook features: * Help browser (opens when executing ``function?``) * Traceback viewer +Links: + +* `Repository at GitHub + `_ +* `Issue Tracker at GitHub + `_ +* `Online Documentation + `_ + .. [#] You need to setup :el:symbol:`ein:notebook-console-args` properly .. [#] Use the command :el:symbol:`ein:connect-to-notebook`. -Keybinds --------- +Quick try +--------- + +This is a quick and clean way to try EIN separately from your Emacs +setting. If you want to try EIN but think preparing all the +requirements is too much, try this!:: + + git clone git://github.com/tkf/zeroein.git + zeroein/zeroein.py + +This will launch a new Emacs instance. For more information, see:: + + zeroein/zeroein.py --help + + +Requirements +------------ + +* IPython_ **0.12.1** (or developmental version): + EIN won't work with older versions. +* `websocket.el`_ +* (optional) mumamo_: + It will be automatically loaded when it is on the path. + The official way to setup path is to load nXhtml_. +* (optional) markdown-mode +* (optional) python-mode: + It should work with either python.el or python-mode.el. + Fabian Gallina's `python.el`_ is required to use + ``ein:notebook-console-open`` command. +* (optional) `auto-complete.el`_ + You need to configure subpackage ``ein-ac`` to enable + this feature. +* (optional) `smartrep.el`_: + This package enables you to omit typing prefix keys (e.g., + ``C-c C-n C-n C-n ...`` instead of ``C-c C-n C-c C-n C-c C-n ...``). + You need to configure subpackage ``ein-smartrep`` to enable + this feature. + +Also, EIN heavily relies on standard Emacs libraries including EWOC +and EIEIO. EIN is currently tested in Emacs 24.1. + +.. _IPython: http://ipython.org/ +.. _websocket.el: https://github.com/ahyatt/emacs-websocket +.. _mumamo: http://www.emacswiki.org/emacs/MuMaMo +.. _nXhtml: http://ourcomments.org/Emacs/nXhtml/doc/nxhtml.html +.. _python.el: https://github.com/fgallina/python.el +.. _auto-complete.el: http://cx4a.org/software/auto-complete/ +.. _smartrep.el: https://github.com/myuhe/smartrep.el + + +Usage +----- + + +1. Install module. + Put Emacs lisp ``ein*.el`` files and Python file ``ein.py`` in your + load path. + +2. Require module:: + + (require 'ein) + +3. Start `IPython notebook server`_. + +4. Hit ``M-x ein:notebooklist-open`` to open notebook list. + +.. _`IPython notebook server`: + http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html + + +Commands/Keybinds +----------------- Notebook list ^^^^^^^^^^^^^ diff --git a/index.html b/index.html index cbdbb85..b86bc14 100644 --- a/index.html +++ b/index.html @@ -67,6 +67,12 @@ object).
  • Help browser (opens when executing function?)
  • Traceback viewer
    • +

    Links:

    + @@ -79,8 +85,64 @@ object).
    [2]Use the command ein:connect-to-notebook.
    -
    -

    Keybinds

    +
    +

    Quick try

    +

    This is a quick and clean way to try EIN separately from your Emacs +setting. If you want to try EIN but think preparing all the +requirements is too much, try this!:

    +
    git clone git://github.com/tkf/zeroein.git
+zeroein/zeroein.py
    +
    +

    This will launch a new Emacs instance. For more information, see:

    +
    zeroein/zeroein.py --help
+
    +
    +
    +
    +

    Requirements

    +
      +
    • IPython 0.12.1 (or developmental version): +EIN won’t work with older versions.
      • +
    • websocket.el
      • +
    • (optional) mumamo: +It will be automatically loaded when it is on the path. +The official way to setup path is to load nXhtml.
      • +
    • (optional) markdown-mode
      • +
    • (optional) python-mode: +It should work with either python.el or python-mode.el. +Fabian Gallina’s python.el is required to use +ein:notebook-console-open command.
      • +
    • (optional) auto-complete.el +You need to configure subpackage ein-ac to enable +this feature.
      • +
    • (optional) smartrep.el: +This package enables you to omit typing prefix keys (e.g., +C-c C-n C-n C-n ... instead of C-c C-n C-c C-n C-c C-n ...). +You need to configure subpackage ein-smartrep to enable +this feature.
      • +
    +

    Also, EIN heavily relies on standard Emacs libraries including EWOC +and EIEIO. EIN is currently tested in Emacs 24.1.

    +
    +
    +

    Usage

    +
      +

    1. Install module. +Put Emacs lisp ein*.el files and Python file ein.py in your +load path.

      +
      2. +

    2. Require module:

      +
      (require 'ein)
      +
      +
      3. +

    3. Start IPython notebook server.

      +
      4. +

    4. Hit M-x ein:notebooklist-open to open notebook list.

      +
      5. +
    +
    +
    +

    Commands/Keybinds

    Notebook list

    You can start notebook by M-x ein:notebooklist-open and enter the @@ -707,8 +769,8 @@ Types same as -

    MuMaMo

    +
    +

    MuMaMo

    variable ein:mumamo-codecell-mode
    diff --git a/searchindex.js b/searchindex.js index b8c7278..726c120 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{"default":0,all:0,code:0,help:0,execut:0,show:0,scratch:0,over:0,global:0,slime:0,rest:0,syntax:0,prefix:0,markdown:0,kill:0,tooltip:0,equival:0,hierarchi:0,follow:0,yet:0,down:0,keybind:0,millisecond:0,access:0,onli:0,cut:0,group:0,easi:0,graph:0,configur:0,send:0,should:0,window:0,html:0,requir:0,text:0,input:0,hidden:0,save:0,alter:0,minibuff:0,split:0,bin:0,applic:0,non:0,move:0,hit:0,string:0,thei:0,python:0,auto:0,safe:0,alist:0,handi:0,becaus:0,delq:0,repl:0,ssh:0,interrupt:0,bit:0,now:0,enter:0,restart:0,like:0,insert:0,magic:0,enabl:0,level:0,lisp:0,hierarchymag:0,cell:0,list:0,url:0,integ:0,server:0,"try":0,easili:0,fabian:0,integr:0,timeout:0,each:0,debug:0,fulli:0,complet:0,where:0,side:0,dir:0,view:0,kernel:0,set:0,map:0,manual:0,visibl:0,back:0,markdowncel:0,realli:0,past:0,emac:0,popup:0,connect:0,arg:0,patch:0,port:0,"goto":0,even:0,index:0,hide:0,appear:0,item:0,someth:0,normal:0,definit:0,ret:0,current:0,delet:0,nbpath:0,notebooklist:0,"new":0,order:0,mumamo:0,mode:0,who:0,run:0,deriv:0,insid:0,whose:0,inspect:0,buri:0,differ:0,undo:0,pytool:0,explicitli:0,output:0,ipython:0,path:0,hacki:0,typic:0,after:0,addit:0,search:0,actual:0,extens:0,smartrep:0,region:0,omit:0,ask:0,gallina:0,page:0,unsav:0,thing:0,keymap:0,codecel:0,act:0,setup:0,goodi:0,chang:0,ein:0,whole:0,other:0,block:0,first:0,load:0,major:0,via:0,directli:0,point:0,onc:0,misc:0,number:0,pop:0,textcel:0,put:0,api:0,littl:0,"__name__":0,instal:0,ring:0,next:0,open:0,your:0,select:0,merg:0,kei:0,given:0,from:0,creat:0,wai:0,data:0,support:0,two:0,empti:0,custom:0,avail:0,start:0,program:0,cbarg:0,valu:0,which:0,call:0,care:0,type:0,store:0,quickli:0,"function":0,head:0,properli:0,consol:0,option:0,name:0,everi:0,imag:0,copi:0,specifi:0,argument:0,warn:0,provid:0,part:0,understand:0,templat:0,rawcel:0,inlin:0,renam:0,must:0,headingcel:0,jump:0,kind:0,prev:0,last:0,tab:0,possibl:0,whether:0,plain:0,remov:0,when:0,see:0,dev:0,exampl:0,defin:0,below:0,toggl:0,none:0,bind:0,posit:0,highlight:0,minor:0,clear:0,htmlcell:0,propag:0,result:0,traceback:0,prompt:0,have:0,helper:0,give:0,viewer:0,can:0,"__main__":0,share:0,them:0,indic:0,raw:0,befor:0,sourc:0,tabl:0,evalu:0,file:0,abov:0,need:0,"return":0,doe:0,featur:0,check:0,superpack:0,browser:0,develop:0,welcom:0,want:0,etc:0,inherit:0,make:0,tip:0,same:0,client:0,note:0,also:0,complex:0,take:0,prefer:0,instead:0,you:0,document:0,simpl:0,tool:0,collaps:0,valid:0,variabl:0,draw:0,http:0,hostnam:0,nil:0,alwai:0,buffer:0,symbol:0,previou:0,usabl:0,much:0,"class":0,plai:0,notebook:0,queri:0,user:0,eval:0,discard:0,mai:0,immedi:0,contain:0,pager:0,stack:0,preset:0,newlin:0,subpackag:0,don:0,ani:0,choos:0,directori:0,entri:0,random:0,secur:0,request:0,object:0,element:0,callback:0,without:0,command:0,setq:0,thi:0,time:0,fallback:0,yank:0,avoid:0,latest:0},objtypes:{},titles:["Welcome to Emacs IPython Notebook’s documentation!"],objnames:{},filenames:["index"]}) \ No newline at end of file +Search.setIndex({objects:{},terms:{all:0,code:0,scratch:0,global:0,prefix:0,follow:0,keybind:0,millisecond:0,whose:0,graph:0,send:0,program:0,queri:0,sourc:0,everi:0,string:0,delq:0,magic:0,level:0,lisp:0,list:0,"try":0,item:0,quick:0,setup:0,dir:0,markdowncel:0,past:0,port:0,even:0,index:0,hide:0,appear:0,cell:0,delet:0,version:0,"new":0,deriv:0,usag:0,pytool:0,ewoc:0,path:0,valu:0,search:0,keymap:0,chang:0,via:0,modul:0,prefer:0,textcel:0,ask:0,api:0,visibl:0,instal:0,select:0,from:0,two:0,next:0,call:0,prev:0,type:0,toggl:0,more:0,warn:0,templat:0,rawcel:0,must:0,none:0,prepar:0,work:0,dev:0,can:0,omit:0,prompt:0,want:0,give:0,share:0,indic:0,tab:0,onlin:0,alwai:0,newlin:0,secur:0,instead:0,simpl:0,collaps:0,map:0,clone:0,after:0,usabl:0,befor:0,notebook:0,goodi:0,mai:0,data:0,github:0,bind:0,element:0,issu:0,inform:0,enter:0,fallback:0,order:0,help:0,over:0,move:0,becaus:0,hierarchi:0,group:0,window:0,complex:0,requir:0,hidden:0,alter:0,non:0,"return":0,thei:0,python:0,auto:0,safe:0,alist:0,handi:0,interrupt:0,now:0,name:0,hierarchymag:0,separ:0,easili:0,fabian:0,mode:0,timeout:0,each:0,debug:0,fulli:0,side:0,codecel:0,nxhtml:0,realli:0,connect:0,variabl:0,ret:0,nbpath:0,notebooklist:0,"goto":0,insid:0,differ:0,undo:0,standard:0,put:0,care:0,launch:0,traceback:0,gallina:0,thing:0,think:0,first:0,major:0,directli:0,onc:0,misc:0,number:0,ring:0,open:0,given:0,stack:0,too:0,store:0,consol:0,option:0,tool:0,copi:0,specifi:0,part:0,headingcel:0,jump:0,kind:0,provid:0,remov:0,emac:0,entri:0,posit:0,zeroein:0,browser:0,websocket:0,viewer:0,ani:0,raw:0,inherit:0,have:0,tabl:0,need:0,equival:0,callback:0,client:0,note:0,also:0,exampl:0,take:0,which:0,normal:0,buffer:0,previou:0,plai:0,preset:0,pager:0,"class":0,don:0,url:0,clear:0,request:0,doe:0,clean:0,yank:0,tkf:0,show:0,text:0,random:0,syntax:0,current:0,onli:0,explicitli:0,configur:0,should:0,offici:0,hit:0,repl:0,ssh:0,restart:0,enabl:0,patch:0,"default":0,integr:0,contain:0,where:0,view:0,kernel:0,set:0,see:0,result:0,arg:0,someth:0,won:0,mumamo:0,popup:0,kei:0,extens:0,ipython:0,addit:0,last:0,region:0,etc:0,instanc:0,com:0,load:0,markdown:0,point:0,pop:0,creat:0,empti:0,much:0,cbarg:0,immedi:0,quickli:0,imag:0,argument:0,understand:0,packag:0,plain:0,defin:0,abov:0,ein:0,propag:0,helper:0,"__main__":0,them:0,develop:0,welcom:0,make:0,same:0,html:0,split:0,document:0,complet:0,development:0,http:0,hostnam:0,nil:0,user:0,typic:0,subpackag:0,older:0,whole:0,object:0,without:0,command:0,setq:0,thi:0,choos:0,latest:0,execut:0,tip:0,slime:0,rest:0,kill:0,heavili:0,yet:0,cut:0,easi:0,littl:0,other:0,input:0,save:0,minibuff:0,bin:0,applic:0,bit:0,superpack:0,insert:0,like:0,manual:0,integ:0,server:0,either:0,output:0,smartrep:0,page:0,back:0,hacki:0,librari:0,avoid:0,definit:0,tooltip:0,tracker:0,who:0,run:0,inspect:0,buri:0,repositori:0,"__name__":0,actual:0,unsav:0,act:0,discard:0,block:0,automat:0,down:0,your:0,merg:0,git:0,wai:0,support:0,custom:0,avail:0,start:0,reli:0,includ:0,"function":0,head:0,properli:0,link:0,renam:0,inlin:0,possibl:0,whether:0,access:0,below:0,minor:0,highlight:0,htmlcell:0,featur:0,evalu:0,eieio:0,file:0,check:0,when:0,valid:0,test:0,you:0,draw:0,symbol:0,eval:0,directori:0,time:0},objtypes:{},titles:["Welcome to Emacs IPython Notebook’s documentation!"],objnames:{},filenames:["index"]}) \ No newline at end of file