Update documentation to newest version.

_sources/index.txt

@@ -96,9 +96,8 @@ Requirements
   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:console-open`` command.
+  It should work with either python.el or python-mode.el. `python.el`_ is
+  required to use ``ein:console-open`` command.
 * (optional) `auto-complete.el`_
   You need to configure subpackage ``ein-ac`` to enable
   this feature.
@@ -114,8 +113,7 @@ Requirements
   ``(add-hook 'ein:connect-mode-hook 'ein:jedi-setup)``
 
 Also, EIN heavily relies on standard Emacs libraries including EWOC,
-EIEIO and json.el.  EIN is currently tested against Emacs 23.3 and 24.3.
-It is known to work in Emacs 23.2, 24.1 and 24.2.
+EIEIO and json.el.
 
 .. _IPython: http://ipython.org/
 .. _Tornado: http://www.tornadoweb.org/en/stable/
@@ -249,7 +247,13 @@ port or URL of the IPython notebook server.
 Notebook
 ^^^^^^^^
 
-The following keybinds are available in notebook buffers.
+The following keybinds are available in notebook buffers. Modified notebooks are
+saved automatically with a frequency dependenant on the setting of
+`ein:notebook-autosave-frequency`. If `ein:notebook-create-checkpoint-on-save`
+is True than a checkpoint will also be generated in the Jupyter server every
+time the notebook is saved. A notebook can be returned to a previous checkpoint
+via `ein:notebook-restore-to-checkpoint`. Checkpoints can also be manually
+created via `ein:notebook-create-checkpoint`.
 
 .. el:keymap:: ein:notebook-mode-map
    :replace: s/C-c TAB/C-c C-i/
@@ -260,6 +264,28 @@ The following keybinds are available in notebook buffers.
 .. el:function:: ein:junk-rename
 .. el:function:: ein:notebook-kill-all-buffers
 .. el:function:: ein:iexec-mode
+.. el.function:: ein:notebook-create-checkpoint
+.. el:function:: ein:notebook-restore-to-checkpoint
+.. el:function:: ein:notebook-enable-autosaves
+.. el:function:: ein:notebook-disable-autosaves
+
+Advanced Editing
+^^^^^^^^^^^^^^^^
+
+Worksheet cells can be edited in a manner similar to `source blocks`_ in Org
+buffers. Use ``C-c '`` to edit the contents of the current cell. You can execute
+the contents of the buffer and the results will be sent to the output of the
+cell being edited.
+
+.. el:keymap:: ein:edit-cell-mode-map
+
+.. el:function:: ein:edit-cell-contents
+.. el:function:: ein:edit-cell-exit
+.. el:function:: ein:edit-cell-abort
+.. el:function:: ein:edit-cell-save
+.. el:function:: ein:edit-cell-save-and-execute
+
+.. _`source blocks`: http://orgmode.org/manual/Editing-source-code.html#Editing-source-code
 
 Connected buffer
 ^^^^^^^^^^^^^^^^
@@ -325,7 +351,22 @@ Misc
 Org-mode integration
 --------------------
 
-You can link to IPython notebook from org-mode_ files.
+You can execute org source blocks in EIN by adding `ein` to
+`org:babel-load-languages`. You need to specify a notebook via the :session
+argument. The format for the session argument is
+`{url-or-port}/{path-to-notbooke}`. For example:
+
+.. code:: python
+
+   #+BEGIN_SRC ein :session 8888/Untitled.ipynb
+   import sys
+
+   a = 14500
+   b = a+1000
+   sys.version
+   #+END_SRC
+
+You can also link to IPython notebook from org-mode_ files.
 
 1. Call org-mode function :el:symbol:`org-store-link`
    [#org-store-link]_ in notebook buffer.  You can select a region to
@@ -385,6 +426,8 @@ Notebook
 .. el:variable:: ein:output-type-preference
 .. el:variable:: ein:shr-env
 .. el.variable:: ein:worksheet-show-slide-data
+.. el.variable:: ein:notebook-autosave-frequency
+.. el.variable:: ein:notebook-create-checkpoint-on-save
 
 Console
 ^^^^^^^
@@ -564,6 +607,28 @@ everything the log buffer.  You can reset the patch and log level with
 Change Log
 ==========
 
+v0.12.0
+-------
+
+* Cell edit buffers ala org source block edit buffers.
+* Better integration with org source blocks.
+
+v0.11.0
+-------
+
+* Add support for creating and restoring checkpoints on the Jupyter server.
+
+v0.10.0
+-------
+
+* Allow user to change the kernel of a running notebook.
+* The notebooklist buffer now lists all opened notebook buffers.
+
+v0.9.1
+------
+
+* Fix issues with shared-output and notebook connected buffers.
+
 v0.9.0
 ------
 

_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -52,6 +52,8 @@ div.sphinxsidebar {
     width: 230px;
     margin-left: -100%;
     font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
 }
 
 div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
     width: 170px;
 }
 
-div.sphinxsidebar #searchbox input[type="submit"] {
-    width: 30px;
-}
-
 img {
     border: 0;
     max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
 
 /* -- general body styles --------------------------------------------------- */
 
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
 a.headerlink {
     visibility: hidden;
 }

_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -124,6 +124,7 @@ var Documentation = {
     this.fixFirefoxAnchorBug();
     this.highlightSearchWords();
     this.initIndexTable();
+    
   },
 
   /**
@@ -252,6 +253,29 @@ var Documentation = {
     });
     var url = parts.join('/');
     return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+  },
+
+  initOnKeyListeners: function() {
+    $(document).keyup(function(event) {
+      var activeElementType = document.activeElement.tagName;
+      // don't navigate when in search box or textarea
+      if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
+        switch (event.keyCode) {
+          case 37: // left
+            var prevHref = $('link[rel="prev"]').prop('href');
+            if (prevHref) {
+              window.location.href = prevHref;
+              return false;
+            }
+          case 39: // right
+            var nextHref = $('link[rel="next"]').prop('href');
+            if (nextHref) {
+              window.location.href = nextHref;
+              return false;
+            }
+        }
+      }
+    });
   }
 };
 

_static/nature.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- nature theme.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

_static/searchtools.js

@@ -2,14 +2,15 @@
  * searchtools.js_t
  * ~~~~~~~~~~~~~~~~
  *
- * Sphinx JavaScript utilties for the full-text search.
+ * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
 
 
+/* Non-minified version JS is _stemmer.js if file is provided */ 
 /**
  * Porter Stemmer
  */
@@ -373,8 +374,7 @@ var Search = {
     }
 
     // lookup as search terms in fulltext
-    results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
-                     .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
+    results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
 
     // let the scorer override scores with a custom scoring function
     if (Scorer.score) {
@@ -538,23 +538,47 @@ var Search = {
   /**
    * search for full-text terms in the index
    */
-  performTermsSearch : function(searchterms, excluded, terms, score) {
+  performTermsSearch : function(searchterms, excluded, terms, titleterms) {
     var filenames = this._index.filenames;
     var titles = this._index.titles;
 
-    var i, j, file, files;
+    var i, j, file;
     var fileMap = {};
+    var scoreMap = {};
     var results = [];
 
     // perform the search on the required terms
     for (i = 0; i < searchterms.length; i++) {
       var word = searchterms[i];
+      var files = [];
+      var _o = [
+        {files: terms[word], score: Scorer.term},
+        {files: titleterms[word], score: Scorer.title}
+      ];
+
       // no match but word was a required one
-      if ((files = terms[word]) === undefined)
+      if ($u.every(_o, function(o){return o.files === undefined;})) {
         break;
-      if (files.length === undefined) {
-        files = [files];
       }
+      // found search word in contents
+      $u.each(_o, function(o) {
+        var _files = o.files;
+        if (_files === undefined)
+          return
+
+        if (_files.length === undefined)
+          _files = [_files];
+        files = files.concat(_files);
+
+        // set score for the word in each file to Scorer.term
+        for (j = 0; j < _files.length; j++) {
+          file = _files[j];
+          if (!(file in scoreMap))
+            scoreMap[file] = {}
+          scoreMap[file][word] = o.score;
+        }
+      });
+
       // create the mapping
       for (j = 0; j < files.length; j++) {
         file = files[j];
@@ -576,7 +600,9 @@ var Search = {
       // ensure that none of the excluded terms is in the search result
       for (i = 0; i < excluded.length; i++) {
         if (terms[excluded[i]] == file ||
-          $u.contains(terms[excluded[i]] || [], file)) {
+            titleterms[excluded[i]] == file ||
+            $u.contains(terms[excluded[i]] || [], file) ||
+            $u.contains(titleterms[excluded[i]] || [], file)) {
           valid = false;
           break;
         }
@@ -584,6 +610,9 @@ var Search = {
 
       // if we have still a valid result we can add it to the result list
       if (valid) {
+        // select one (max) score for the file.
+        // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
+        var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
         results.push([filenames[file], titles[file], '', null, score]);
       }
     }
@@ -594,7 +623,7 @@ var Search = {
    * helper function to return a node containing the
    * search summary for a given text. keywords is a list
    * of stemmed words, hlwords is the list of normal, unstemmed
-   * words. the first one is used to find the occurance, the
+   * words. the first one is used to find the occurrence, the
    * latter for highlighting it.
    */
   makeSearchSummary : function(text, keywords, hlwords) {

_static/websupport.js

@@ -2,9 +2,9 @@
  * websupport.js
  * ~~~~~~~~~~~~~
  *
- * sphinx.websupport utilties for all documentation.
+ * sphinx.websupport utilities for all documentation.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

genindex.html

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Index &mdash; Emacs IPython Notebook 0.8.2 documentation</title>
+    <title>Index &#8212; Emacs IPython Notebook 0.12.0 documentation</title>
     
     <link rel="stylesheet" href="_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.8.2',
+        VERSION:     '0.12.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Emacs IPython Notebook 0.8.2 documentation" href="index.html" /> 
+    <link rel="top" title="Emacs IPython Notebook 0.12.0 documentation" href="index.html" /> 
   </head>
   <body role="document">
     <div class="related" role="navigation" aria-label="related navigation">
@@ -33,7 +33,7 @@
         <li class="right" style="margin-right: 10px">
           <a href="#" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.8.2 documentation</a> &raquo;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.12.0 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -142,6 +142,26 @@
   </dt>
 
       
+  <dt><a href="index.html#ein:edit-cell-abort">ein:edit-cell-abort (Lisp function)</a>
+  </dt>
+
+      
+  <dt><a href="index.html#ein:edit-cell-contents">ein:edit-cell-contents (Lisp function)</a>
+  </dt>
+
+      
+  <dt><a href="index.html#ein:edit-cell-exit">ein:edit-cell-exit (Lisp function)</a>
+  </dt>
+
+      
+  <dt><a href="index.html#ein:edit-cell-save">ein:edit-cell-save (Lisp function)</a>
+  </dt>
+
+      
+  <dt><a href="index.html#ein:edit-cell-save-and-execute">ein:edit-cell-save-and-execute (Lisp function)</a>
+  </dt>
+
+      
   <dt><a href="index.html#ein:filename-translations">ein:filename-translations (Lisp variable)</a>
   </dt>
 
@@ -193,12 +213,12 @@
   <dt><a href="index.html#ein:mumamo-headingcell-mode">ein:mumamo-headingcell-mode (Lisp variable)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
       
   <dt><a href="index.html#ein:mumamo-htmlcell-mode">ein:mumamo-htmlcell-mode (Lisp variable)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
       
   <dt><a href="index.html#ein:mumamo-markdowncell-mode">ein:mumamo-markdowncell-mode (Lisp variable)</a>
   </dt>
@@ -212,6 +232,14 @@
   </dt>
 
       
+  <dt><a href="index.html#ein:notebook-disable-autosaves">ein:notebook-disable-autosaves (Lisp function)</a>
+  </dt>
+
+      
+  <dt><a href="index.html#ein:notebook-enable-autosaves">ein:notebook-enable-autosaves (Lisp function)</a>
+  </dt>
+
+      
   <dt><a href="index.html#ein:notebook-kill-all-buffers">ein:notebook-kill-all-buffers (Lisp function)</a>
   </dt>
 
@@ -232,6 +260,10 @@
   </dt>
 
       
+  <dt><a href="index.html#ein:notebook-restore-to-checkpoint">ein:notebook-restore-to-checkpoint (Lisp function)</a>
+  </dt>
+
+      
   <dt><a href="index.html#ein:notebooklist-load">ein:notebooklist-load (Lisp function)</a>
   </dt>
 
@@ -358,12 +390,12 @@
         <li class="right" style="margin-right: 10px">
           <a href="#" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.8.2 documentation</a> &raquo;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.12.0 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &copy; Copyright 2015, John Miller.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
+        &#169; Copyright 2015, John Miller.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
     </div>
   </body>
 </html>

search.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Search &mdash; Emacs IPython Notebook 0.8.2 documentation</title>
+    <title>Search &#8212; Emacs IPython Notebook 0.12.0 documentation</title>
     
     <link rel="stylesheet" href="_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.8.2',
+        VERSION:     '0.12.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <script type="text/javascript" src="_static/searchtools.js"></script>
-    <link rel="top" title="Emacs IPython Notebook 0.8.2 documentation" href="index.html" />
+    <link rel="top" title="Emacs IPython Notebook 0.12.0 documentation" href="index.html" />
   <script type="text/javascript">
     jQuery(function() { Search.loadIndex("searchindex.js"); });
   </script>
@@ -40,7 +40,7 @@
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.8.2 documentation</a> &raquo;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.12.0 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -82,12 +82,12 @@
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.8.2 documentation</a> &raquo;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">Emacs IPython Notebook 0.12.0 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &copy; Copyright 2015, John Miller.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
+        &#169; Copyright 2015, John Miller.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
     </div>
   </body>
 </html>