hiro/emacs-ipython-notebook
1
0
Fork 0
mirror of https://github.com/vale981/emacs-ipython-notebook synced 2025-03-06 01:21:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update

Browse source
This commit is contained in:
Takafumi Arakaki 2012-08-11 18:07:13 +02:00
parent 2391fa5350
commit c5d91e3649
6 changed files with 333 additions and 142 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
_sources/index.txt
View file

@ -52,7 +52,7 @@ Links:
<https://github.com/tkf/emacs-ipython-notebook/issues>`_
.. [#] You need to setup :el:symbol:`ein:notebook-console-args` properly
.. [#] Use the command :el:symbol:`ein:connect-to-notebook`.
.. [#] Use the command :el:symbol:`ein:connect-to-notebook-command`.
.. contents::
@ -220,7 +220,7 @@ The following keybinds are available in notebook buffers.
.. el:function:: ein:notebook-delete-cell-command
.. el:function:: ein:notebook-rename-to-scratch-command
.. el:function:: ein:notebook-kill-all-buffers
.. el:function:: ein:autoexec-mode
.. el:function:: ein:iexec-mode
Connected buffer
^^^^^^^^^^^^^^^^
@ -236,7 +236,7 @@ are available.
Other useful commands:
.. el:function:: ein:connect-to-notebook
.. el:function:: ein:connect-to-notebook-command
.. el:function:: ein:connect-eval-buffer
.. el:function:: ein:connect-run-buffer
@ -267,6 +267,17 @@ buffer.
.. el:function:: ein:pytools-hierarchy
.. el:function:: ein:pytools-pandas-to-ses
Misc
^^^^
.. el:package:: helm
.. el:function:: helm-ein-notebook-buffers
.. el:package:: anything
.. el:function:: anything-ein-notebook-buffers
.. el:package:: ein
.. It is better to remove el:package from eldomain??
Customization
-------------
@ -303,9 +314,10 @@ Notebook
.. el:variable:: ein:notebook-console-executable
.. el:variable:: ein:notebook-console-args
.. el:variable:: ein:cell-traceback-level
.. el:variable:: ein:cell-max-num-outputs
.. el:variable:: ein:cell-autoexec-prompt
.. el:variable:: ein:scratch-notebook-name-template
.. el:variable:: ein:autoexec-delay
.. el:variable:: ein:iexec-delay
.. el:variable:: ein:complete-on-dot
Connect
^^^^^^^
@ -313,6 +325,7 @@ Connect
.. el:variable:: ein:connect-run-command
.. el:variable:: ein:connect-save-before-run
.. el:variable:: ein:propagate-connect
.. el:variable:: ein:connect-aotoexec-lighter
MuMaMo
^^^^^^
@ -329,6 +342,8 @@ MuMaMo
Misc
^^^^
.. el:variable:: ein:filename-translations
.. el:function:: ein:tramp-create-filename-translator
.. el:variable:: ein:query-timeout
@ -465,18 +480,32 @@ v0.1.1
* Support `auto-complete.el`_\ 's popup/quick help.
* Add :el:symbol:`ein:notebooklist-first-open-hook`.
* :el:symbol:`ein:connect-to-notebook` is improved; it can connect to
the notebook which is not opened yet.
* Handle carriage return
(`#13 <https://github.com/tkf/emacs-ipython-notebook/issues/13>`_).
* :el:symbol:`ein:connect-to-notebook-command` is improved;
it can connect to the notebook which is not opened yet.
* Plain text type output is favored over LaTeX type output
(previous setting was opposite).
* Workaround indentation problem when using MuMaMo
(`#20 <https://github.com/tkf/emacs-ipython-notebook/issues/20>`_).
See :el:symbol:`ein:use-mumamo-indent-line-function-workaround`.
* Add :el:symbol:`ein:notebook-rename-to-scratch-command`.
* Introduce :el:symbol:`ein:notebook-show-in-shared-output` command
and :el:symbol:`ein:cell-max-num-outputs` configuration variable to
truncate long output and show it in a separated buffer.
* Add :el:symbol:`ein:pytools-pandas-to-ses`.
* Add Imenu support.
* Better heading cell faces.
* Add :el:symbol:`ein:autoexec-mode`
* Add :el:symbol:`ein:iexec-mode`
* Add auto-execution mode
(see :el:symbol:`ein:connect-toggle-autoexec` and
:el:symbol:`ein:notebook-turn-on-autoexec`).
* Start completion when "." is inserted.
Use :el:symbol:`ein:complete-on-dot` to disable this feature.
* Support tramp. See :el:symbol:`ein:filename-translations`.
* Change callback API in :el:symbol:`ein:kernel-execute`
to adapt messaging protocol change in
`IPython (#2051) <https://github.com/ipython/ipython/pull/2051>`_.
* Add helm/anything support.
Use :el:symbol:`helm-ein-notebook-buffers` or
:el:symbol:`anything-ein-notebook-buffers`.
v0.1

74
genindex.html
View file

@ -9,7 +9,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; Emacs IPython Notebook 0.1.1alpha0 documentation</title>
<title>Index &mdash; Emacs IPython Notebook 0.1.2alpha0 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -17,7 +17,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.1alpha0',
VERSION: '0.1.2alpha0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -26,7 +26,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.1.1alpha0 documentation" href="index.html" />
<link rel="top" title="Emacs IPython Notebook 0.1.2alpha0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -35,7 +35,7 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">Emacs IPython Notebook 0.1.1alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.1.2alpha0 documentation</a> &raquo;</li>
</ul>
</div>
@ -47,9 +47,21 @@
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#E"><strong>E</strong></a>
<a href="#A"><strong>A</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#H"><strong>H</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#anything-ein-notebook-buffers">anything-ein-notebook-buffers (Lisp function)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
@ -58,15 +70,7 @@
</dt>
<dt><a href="index.html#ein:autoexec-delay">ein:autoexec-delay (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:autoexec-mode">ein:autoexec-mode (Lisp function)</a>
</dt>
<dt><a href="index.html#ein:cell-max-num-outputs">ein:cell-max-num-outputs (Lisp variable)</a>
<dt><a href="index.html#ein:cell-autoexec-prompt">ein:cell-autoexec-prompt (Lisp variable)</a>
</dt>
@ -74,6 +78,14 @@
</dt>
<dt><a href="index.html#ein:complete-on-dot">ein:complete-on-dot (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:connect-aotoexec-lighter">ein:connect-aotoexec-lighter (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:connect-eval-buffer">ein:connect-eval-buffer (Lisp function)</a>
</dt>
@ -90,7 +102,7 @@
</dt>
<dt><a href="index.html#ein:connect-to-notebook">ein:connect-to-notebook (Lisp function)</a>
<dt><a href="index.html#ein:connect-to-notebook-command">ein:connect-to-notebook-command (Lisp function)</a>
</dt>
@ -98,6 +110,18 @@
</dt>
<dt><a href="index.html#ein:filename-translations">ein:filename-translations (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:iexec-delay">ein:iexec-delay (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:iexec-mode">ein:iexec-mode (Lisp function)</a>
</dt>
<dt><a href="index.html#ein:load-dev">ein:load-dev (Lisp variable)</a>
</dt>
@ -145,12 +169,12 @@
<dt><a href="index.html#ein:notebook-delete-cell-command">ein:notebook-delete-cell-command (Lisp function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#ein:notebook-discard-output-on-save">ein:notebook-discard-output-on-save (Lisp variable)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#ein:notebook-enable-undo">ein:notebook-enable-undo (Lisp variable)</a>
</dt>
@ -228,6 +252,10 @@
</dt>
<dt><a href="index.html#ein:tramp-create-filename-translator">ein:tramp-create-filename-translator (Lisp function)</a>
</dt>
<dt><a href="index.html#ein:url-or-port">ein:url-or-port (Lisp variable)</a>
</dt>
@ -247,6 +275,16 @@
<dt><a href="index.html#ein:use-smartrep">ein:use-smartrep (Lisp variable)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#helm-ein-notebook-buffers">helm-ein-notebook-buffers (Lisp function)</a>
</dt>
</dl></td>
</tr></table>
@ -262,7 +300,7 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">Emacs IPython Notebook 0.1.1alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.1.2alpha0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

336
index.html
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Emacs IPython Notebook’s documentation! &mdash; Emacs IPython Notebook 0.1.1alpha0 documentation</title>
<title>Welcome to Emacs IPython Notebook’s documentation! &mdash; Emacs IPython Notebook 0.1.2alpha0 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.1.1alpha0',
VERSION: '0.1.2alpha0',
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.1.1alpha0 documentation" href="#" />
<link rel="top" title="Emacs IPython Notebook 0.1.2alpha0 documentation" href="#" />
</head>
<body>
<div class="related">
@ -33,7 +33,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="#">Emacs IPython Notebook 0.1.1alpha0 documentation</a> &raquo;</li>
<li><a href="#">Emacs IPython Notebook 0.1.2alpha0 documentation</a> &raquo;</li>
</ul>
</div>
@ -42,7 +42,7 @@
<div class="body">
<div class="section" id="welcome-to-emacs-ipython-notebook-s-documentation">
<h1><a class="toc-backref" href="#id14">Welcome to Emacs IPython Notebook&#8217;s documentation!</a><a class="headerlink" href="#welcome-to-emacs-ipython-notebook-s-documentation" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id17">Welcome to Emacs IPython Notebook&#8217;s documentation!</a><a class="headerlink" href="#welcome-to-emacs-ipython-notebook-s-documentation" title="Permalink to this headline"></a></h1>
<p>Emacs IPython Notebook (EIN) provides fully featured IPython Notebook
client and integrated REPL (like <a class="reference external" href="http://common-lisp.net/project/slime/">SLIME</a>). While EIN makes notebook
editing very powerful by allowing you to use any Emacs features, it
@ -89,69 +89,70 @@ object).</li>
<table class="docutils footnote" frame="void" id="id4" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Use the command <a class="reference internal" href="#ein:connect-to-notebook" title="ein:connect-to-notebook"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-to-notebook</span></tt></a>.</td></tr>
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Use the command <a class="reference internal" href="#ein:connect-to-notebook-command" title="ein:connect-to-notebook-command"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-to-notebook-command</span></tt></a>.</td></tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#welcome-to-emacs-ipython-notebook-s-documentation" id="id14">Welcome to Emacs IPython Notebook&#8217;s documentation!</a><ul>
<li><a class="reference internal" href="#quick-try" id="id15">Quick try</a></li>
<li><a class="reference internal" href="#requirements" id="id16">Requirements</a></li>
<li><a class="reference internal" href="#install" id="id17">Install</a><ul>
<li><a class="reference internal" href="#using-el-get" id="id18">Using el-get</a></li>
<li><a class="reference internal" href="#using-package-el-melpa" id="id19">Using package.el (MELPA)</a></li>
<li><a class="reference internal" href="#manual-install" id="id20">Manual install</a></li>
<li><a class="reference internal" href="#setup" id="id21">Setup</a></li>
<li><a class="reference internal" href="#welcome-to-emacs-ipython-notebook-s-documentation" id="id17">Welcome to Emacs IPython Notebook&#8217;s documentation!</a><ul>
<li><a class="reference internal" href="#quick-try" id="id18">Quick try</a></li>
<li><a class="reference internal" href="#requirements" id="id19">Requirements</a></li>
<li><a class="reference internal" href="#install" id="id20">Install</a><ul>
<li><a class="reference internal" href="#using-el-get" id="id21">Using el-get</a></li>
<li><a class="reference internal" href="#using-package-el-melpa" id="id22">Using package.el (MELPA)</a></li>
<li><a class="reference internal" href="#manual-install" id="id23">Manual install</a></li>
<li><a class="reference internal" href="#setup" id="id24">Setup</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id22">Usage</a></li>
<li><a class="reference internal" href="#commands-keybinds" id="id23">Commands/Keybinds</a><ul>
<li><a class="reference internal" href="#notebook-list" id="id24">Notebook list</a></li>
<li><a class="reference internal" href="#notebook" id="id25">Notebook</a></li>
<li><a class="reference internal" href="#connected-buffer" id="id26">Connected buffer</a></li>
<li><a class="reference internal" href="#shared-output-buffer" id="id27">Shared output buffer</a></li>
<li><a class="reference internal" href="#traceback-viewer" id="id28">Traceback viewer</a></li>
<li><a class="reference internal" href="#pytools" id="id29">PyTools</a></li>
<li><a class="reference internal" href="#usage" id="id25">Usage</a></li>
<li><a class="reference internal" href="#commands-keybinds" id="id26">Commands/Keybinds</a><ul>
<li><a class="reference internal" href="#notebook-list" id="id27">Notebook list</a></li>
<li><a class="reference internal" href="#notebook" id="id28">Notebook</a></li>
<li><a class="reference internal" href="#connected-buffer" id="id29">Connected buffer</a></li>
<li><a class="reference internal" href="#shared-output-buffer" id="id30">Shared output buffer</a></li>
<li><a class="reference internal" href="#traceback-viewer" id="id31">Traceback viewer</a></li>
<li><a class="reference internal" href="#pytools" id="id32">PyTools</a></li>
<li><a class="reference internal" href="#misc" id="id33">Misc</a></li>
</ul>
</li>
<li><a class="reference internal" href="#customization" id="id30">Customization</a><ul>
<li><a class="reference internal" href="#subpackages" id="id31">Subpackages</a></li>
<li><a class="reference internal" href="#id7" id="id32">Notebook list</a></li>
<li><a class="reference internal" href="#id8" id="id33">Notebook</a></li>
<li><a class="reference internal" href="#connect" id="id34">Connect</a></li>
<li><a class="reference internal" href="#id9" id="id35">MuMaMo</a></li>
<li><a class="reference internal" href="#misc" id="id36">Misc</a></li>
<li><a class="reference internal" href="#customization" id="id34">Customization</a><ul>
<li><a class="reference internal" href="#subpackages" id="id35">Subpackages</a></li>
<li><a class="reference internal" href="#id7" id="id36">Notebook list</a></li>
<li><a class="reference internal" href="#id8" id="id37">Notebook</a></li>
<li><a class="reference internal" href="#connect" id="id38">Connect</a></li>
<li><a class="reference internal" href="#id9" id="id39">MuMaMo</a></li>
<li><a class="reference internal" href="#id10" id="id40">Misc</a></li>
</ul>
</li>
<li><a class="reference internal" href="#gotchas-and-caveats" id="id37">Gotchas and caveats</a><ul>
<li><a class="reference internal" href="#url-retrieve" id="id38"><tt class="xref el el-symbol docutils literal"><span class="pre">url-retrieve</span></tt></a></li>
<li><a class="reference internal" href="#id10" id="id39">MuMaMo</a></li>
<li><a class="reference internal" href="#gotchas-python-mode-el" id="id40">python-mode.el</a></li>
<li><a class="reference internal" href="#gotchas-and-caveats" id="id41">Gotchas and caveats</a><ul>
<li><a class="reference internal" href="#url-retrieve" id="id42"><tt class="xref el el-symbol docutils literal"><span class="pre">url-retrieve</span></tt></a></li>
<li><a class="reference internal" href="#id11" id="id43">MuMaMo</a></li>
<li><a class="reference internal" href="#gotchas-python-mode-el" id="id44">python-mode.el</a></li>
</ul>
</li>
<li><a class="reference internal" href="#advanced" id="id41">Advanced</a></li>
<li><a class="reference internal" href="#reporting-issue" id="id42">Reporting issue</a><ul>
<li><a class="reference internal" href="#logging" id="id43">Logging</a><ul>
<li><a class="reference internal" href="#id13" id="id44">websocket.el</a></li>
<li><a class="reference internal" href="#advanced" id="id45">Advanced</a></li>
<li><a class="reference internal" href="#reporting-issue" id="id46">Reporting issue</a><ul>
<li><a class="reference internal" href="#logging" id="id47">Logging</a><ul>
<li><a class="reference internal" href="#id14" id="id48">websocket.el</a></li>
</ul>
</li>
<li><a class="reference internal" href="#debugging" id="id45">Debugging</a></li>
<li><a class="reference internal" href="#debugging" id="id49">Debugging</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#change-log" id="id46">Change Log</a><ul>
<li><a class="reference internal" href="#v0-1-1" id="id47">v0.1.1</a></li>
<li><a class="reference internal" href="#v0-1" id="id48">v0.1</a></li>
<li><a class="reference internal" href="#change-log" id="id50">Change Log</a><ul>
<li><a class="reference internal" href="#v0-1-1" id="id51">v0.1.1</a></li>
<li><a class="reference internal" href="#v0-1" id="id52">v0.1</a></li>
</ul>
</li>
<li><a class="reference internal" href="#license" id="id49">License</a></li>
<li><a class="reference internal" href="#indices-and-tables" id="id50">Indices and tables</a></li>
<li><a class="reference internal" href="#license" id="id53">License</a></li>
<li><a class="reference internal" href="#indices-and-tables" id="id54">Indices and tables</a></li>
</ul>
</div>
<div class="section" id="quick-try">
<h2><a class="toc-backref" href="#id15">Quick try</a><a class="headerlink" href="#quick-try" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id18">Quick try</a><a class="headerlink" href="#quick-try" title="Permalink to this headline"></a></h2>
<p>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!:</p>
@ -164,7 +165,7 @@ zeroein/zeroein.py</pre>
</div>
</div>
<div class="section" id="requirements">
<h2><a class="toc-backref" href="#id16">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id19">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="http://ipython.org/">IPython</a> 0.12 or higher.</li>
<li><a class="reference external" href="https://github.com/ahyatt/emacs-websocket">websocket.el</a> 0.9</li>
@ -196,9 +197,9 @@ EIEIO and json.el. EIN is currently tested in Emacs 24.1.</p>
</table>
</div>
<div class="section" id="install">
<h2><a class="toc-backref" href="#id17">Install</a><a class="headerlink" href="#install" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id20">Install</a><a class="headerlink" href="#install" title="Permalink to this headline"></a></h2>
<div class="section" id="using-el-get">
<h3><a class="toc-backref" href="#id18">Using el-get</a><a class="headerlink" href="#using-el-get" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id21">Using el-get</a><a class="headerlink" href="#using-el-get" title="Permalink to this headline"></a></h3>
<p>If you use developmental version of <a class="reference external" href="https://github.com/dimitri/el-get">el-get</a>, you can install it
easily using it. Emacs IPython Notebook is registered as package
<tt class="docutils literal"><span class="pre">ein</span></tt>. See <a class="reference external" href="https://github.com/dimitri/el-get">el-get</a> website for more information.</p>
@ -212,12 +213,12 @@ will solve the problem. Note that this will remove the whole
</div>
</div>
<div class="section" id="using-package-el-melpa">
<h3><a class="toc-backref" href="#id19">Using package.el (MELPA)</a><a class="headerlink" href="#using-package-el-melpa" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id22">Using package.el (MELPA)</a><a class="headerlink" href="#using-package-el-melpa" title="Permalink to this headline"></a></h3>
<p>You can install EIN using <a class="reference external" href="http://emacswiki.org/emacs/ELPA">package.el</a> when <a class="reference external" href="https://github.com/milkypostman/melpa">MELPA</a> package repository
is added to its setting. See <a class="reference external" href="https://github.com/milkypostman/melpa">MELPA</a> website for more information.</p>
</div>
<div class="section" id="manual-install">
<h3><a class="toc-backref" href="#id20">Manual install</a><a class="headerlink" href="#manual-install" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id23">Manual install</a><a class="headerlink" href="#manual-install" title="Permalink to this headline"></a></h3>
<p>Put Emacs lisp <tt class="docutils literal"><span class="pre">ein*.el</span></tt> files and Python file <tt class="docutils literal"><span class="pre">ein.py</span></tt> in
a directory defined in your <tt class="xref el el-symbol docutils literal"><span class="pre">load-path</span></tt>.</p>
<p>You should byte compile EIN, especially when using MuMaMo, otherwise
@ -238,7 +239,7 @@ don&#8217;t use that optional package.</p>
</div>
</div>
<div class="section" id="setup">
<h3><a class="toc-backref" href="#id21">Setup</a><a class="headerlink" href="#setup" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id24">Setup</a><a class="headerlink" href="#setup" title="Permalink to this headline"></a></h3>
<p>Here is the minimal configuration. See <a class="reference internal" href="#customization">customization</a> for more details.</p>
<div class="highlight-cl"><div class="highlight"><pre><span class="p">(</span><span class="nb">require</span> <span class="ss">&#39;ein</span><span class="p">)</span>
</pre></div>
@ -246,7 +247,7 @@ don&#8217;t use that optional package.</p>
</div>
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#id22">Usage</a><a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id25">Usage</a><a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<ol class="arabic simple">
<li>Start <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html">IPython notebook server</a>.</li>
<li>Hit <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">ein:notebooklist-open</span></tt> to open notebook list. This will
@ -257,9 +258,9 @@ section for what you can do in the notebook buffer.</li>
</ol>
</div>
<div class="section" id="commands-keybinds">
<h2><a class="toc-backref" href="#id23">Commands/Keybinds</a><a class="headerlink" href="#commands-keybinds" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id26">Commands/Keybinds</a><a class="headerlink" href="#commands-keybinds" title="Permalink to this headline"></a></h2>
<div class="section" id="notebook-list">
<span id="notebook-list-commands"></span><h3><a class="toc-backref" href="#id24">Notebook list</a><a class="headerlink" href="#notebook-list" title="Permalink to this headline"></a></h3>
<span id="notebook-list-commands"></span><h3><a class="toc-backref" href="#id27">Notebook list</a><a class="headerlink" href="#notebook-list" title="Permalink to this headline"></a></h3>
<p>You can start notebook by <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">ein:notebooklist-open</span></tt> and enter the
port or URL of the IPython notebook server.</p>
<dl class="function">
@ -345,7 +346,7 @@ Notebook name is determined based on
</div>
<div class="section" id="notebook">
<span id="notebook-commands"></span><h3><a class="toc-backref" href="#id25">Notebook</a><a class="headerlink" href="#notebook" title="Permalink to this headline"></a></h3>
<span id="notebook-commands"></span><h3><a class="toc-backref" href="#id28">Notebook</a><a class="headerlink" href="#notebook" title="Permalink to this headline"></a></h3>
<p>The following keybinds are available in notebook buffers.</p>
<dl class="keybind">
<dt>
@ -355,6 +356,18 @@ Notebook name is determined based on
</dd></dd>
</dl>
<dl class="keybind">
<dt>
<tt class="descname">C-c C-'</tt><tt class="descclassname"> ein:notebook-turn-on-autoexec</tt></dt>
</dt>
<dd><dd class="first last"><p>Turn on auto-execution flag of the cells in region or cell at point.
When the prefix argument is given, turn off the flag instead.</p>
<p>To use autoexec feature, you need to turn on auto-execution mode
in connected buffers, using the <tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-toggle-autoexec</span></tt>
command.</p>
</dd></dd>
</dl>
<dl class="keybind">
<dt>
<tt class="descname">C-c C-e</tt><tt class="descclassname"> ein:notebook-toggle-output-command</tt></dt>
@ -395,7 +408,7 @@ Do not clear input prompts when the prefix argument is given.</p>
<tt class="descname">C-c C-;</tt><tt class="descclassname"> ein:notebook-show-in-shared-output</tt></dt>
</dt>
<dd><dd class="first last"><p>Show truncated code cell ouput in shared-output buffer.
See also <a class="reference internal" href="#ein:cell-max-num-outputs" title="ein:cell-max-num-outputs"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:cell-max-num-outputs</span></tt></a> to how to truncate long
See also <tt class="xref el el-symbol docutils literal"><span class="pre">ein:cell-max-num-outputs</span></tt> to how to truncate long
output.</p>
</dd></dd>
</dl>
@ -489,8 +502,8 @@ argument (C-u).</p>
<dt>
<tt class="descname">C-c RET</tt><tt class="descclassname"> ein:notebook-merge-cell-command</tt></dt>
</dt>
<dd><dd class="first last"><p>Merge next cell into current cell.
If prefix is given, merge current cell into previous cell.</p>
<dd><dd class="first last"><p>Merge previous cell into current cell.
If prefix is given, merge current cell into next cell.</p>
</dd></dd>
</dl>
@ -703,16 +716,16 @@ and save it immediately.</p>
</dd></dl>
<dl class="function">
<dt id="ein:autoexec-mode">
<em class="property">function </em><big>(</big><tt class="descname">ein:autoexec-mode </tt><em>&amp;optional</em> <em>arg</em><big>)</big><a class="headerlink" href="#ein:autoexec-mode" title="Permalink to this definition"></a></dt>
<dd><p>Automatic cell execution minor mode.
<dt id="ein:iexec-mode">
<em class="property">function </em><big>(</big><tt class="descname">ein:iexec-mode </tt><em>&amp;optional</em> <em>arg</em><big>)</big><a class="headerlink" href="#ein:iexec-mode" title="Permalink to this definition"></a></dt>
<dd><p>Instant cell execution minor mode.
Code cell at point will be automatically executed after any
change in its input area.</p>
</dd></dl>
</div>
<div class="section" id="connected-buffer">
<h3><a class="toc-backref" href="#id26">Connected buffer</a><a class="headerlink" href="#connected-buffer" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id29">Connected buffer</a><a class="headerlink" href="#connected-buffer" title="Permalink to this headline"></a></h3>
<p>You can connect any buffer (typically buffer opening Python file) to
opened notebook and use the kernel of the notebook to execute the
code, inspect objects, auto-complete code, jump to the other source,
@ -751,6 +764,18 @@ See also: <a class="reference internal" href="#ein:connect-run-buffer" title="ei
<tt class="descname">C-c C-z</tt><tt class="descclassname"> ein:connect-pop-to-notebook</tt></dt>
</dl>
<dl class="keybind">
<dt>
<tt class="descname">C-c C-a</tt><tt class="descclassname"> ein:connect-toggle-autoexec</tt></dt>
</dt>
<dd><dd class="first last"><p>Toggle auto-execution mode of the current connected buffer.</p>
<p>Note that you need to set cells to run in the connecting buffer
or no cell will be executed.
Use the <tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebook-turn-on-autoexec</span></tt> command in notebook to
change the cells to run.</p>
</dd></dd>
</dl>
<dl class="keybind">
<dt>
<tt class="descname">C-c C-.</tt><tt class="descclassname"> ein:pytools-jump-to-source-command</tt></dt>
@ -800,9 +825,12 @@ given, open the last point in the other window.</p>
<p>Other useful commands:</p>
<dl class="function">
<dt id="ein:connect-to-notebook">
<em class="property">function </em><big>(</big><tt class="descname">ein:connect-to-notebook </tt><em>nbpath</em><big>)</big><a class="headerlink" href="#ein:connect-to-notebook" title="Permalink to this definition"></a></dt>
<dd><p>Connect any buffer to notebook and its kernel.</p>
<dt id="ein:connect-to-notebook-command">
<em class="property">function </em><big>(</big><tt class="descname">ein:connect-to-notebook-command </tt><em>&amp;optional</em> <em>not-yet-opened</em><big>)</big><a class="headerlink" href="#ein:connect-to-notebook-command" title="Permalink to this definition"></a></dt>
<dd><p>Connect to notebook. When the prefix argument is given,
you can choose any notebook on your server including the ones
not yet opened. Otherwise, already chose from already opened
notebooks.</p>
</dd></dl>
<dl class="function">
@ -821,7 +849,7 @@ Variable <a class="reference internal" href="#ein:connect-run-command" title="ei
</div>
<div class="section" id="shared-output-buffer">
<h3><a class="toc-backref" href="#id27">Shared output buffer</a><a class="headerlink" href="#shared-output-buffer" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id30">Shared output buffer</a><a class="headerlink" href="#shared-output-buffer" title="Permalink to this headline"></a></h3>
<dl class="function">
<dt id="ein:shared-output-pop-to-buffer">
<em class="property">function </em><tt class="descname">ein:shared-output-pop-to-buffer</tt><a class="headerlink" href="#ein:shared-output-pop-to-buffer" title="Permalink to this definition"></a></dt>
@ -858,7 +886,7 @@ selecting it.</p>
</div>
<div class="section" id="traceback-viewer">
<h3><a class="toc-backref" href="#id28">Traceback viewer</a><a class="headerlink" href="#traceback-viewer" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id31">Traceback viewer</a><a class="headerlink" href="#traceback-viewer" title="Permalink to this headline"></a></h3>
<p>Traceback in notebook buffer is not easy to understand. You can open
Traceback viewer by the command <tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebook-view-traceback</span></tt>.
In the Traceback viewer, following keybinds are available.</p>
@ -885,7 +913,7 @@ In the Traceback viewer, following keybinds are available.</p>
</div>
<div class="section" id="pytools">
<h3><a class="toc-backref" href="#id29">PyTools</a><a class="headerlink" href="#pytools" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id32">PyTools</a><a class="headerlink" href="#pytools" title="Permalink to this headline"></a></h3>
<p>These commands can be used in the notebook buffer and the connected
buffer.</p>
<dl class="function">
@ -917,15 +945,30 @@ Open a <tt class="xref el el-symbol docutils literal"><span class="pre">ses-mode
to install it if you are using newer Emacs.</p>
</dd></dl>
</div>
<div class="section" id="misc">
<h3><a class="toc-backref" href="#id33">Misc</a><a class="headerlink" href="#misc" title="Permalink to this headline"></a></h3>
<dl class="function">
<dt id="helm-ein-notebook-buffers">
<em class="property">function </em><tt class="descname">helm-ein-notebook-buffers</tt><a class="headerlink" href="#helm-ein-notebook-buffers" title="Permalink to this definition"></a></dt>
<dd><p>Choose opened notebook using helm interface.</p>
</dd></dl>
<dl class="function">
<dt id="anything-ein-notebook-buffers">
<em class="property">function </em><tt class="descname">anything-ein-notebook-buffers</tt><a class="headerlink" href="#anything-ein-notebook-buffers" title="Permalink to this definition"></a></dt>
<dd><p>Choose opened notebook using anything.el interface.</p>
</dd></dl>
</div>
</div>
<div class="section" id="customization">
<h2><a class="toc-backref" href="#id30">Customization</a><a class="headerlink" href="#customization" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id34">Customization</a><a class="headerlink" href="#customization" title="Permalink to this headline"></a></h2>
<p>You can customize EIN using the Emacs customization UI by typing
<tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">customize-group</span> <span class="pre">RET</span> <span class="pre">ein</span> <span class="pre">RET</span></tt>.
All the configurable variables are listed below.</p>
<div class="section" id="subpackages">
<h3><a class="toc-backref" href="#id31">Subpackages</a><a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id35">Subpackages</a><a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h3>
<dl class="variable">
<dt id="ein:use-auto-complete">
<em class="property">variable </em><tt class="descname">ein:use-auto-complete</tt><a class="headerlink" href="#ein:use-auto-complete" title="Permalink to this definition"></a></dt>
@ -970,7 +1013,7 @@ commands is fine.</p>
</div>
<div class="section" id="id7">
<h3><a class="toc-backref" href="#id32">Notebook list</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id36">Notebook list</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<dl class="variable">
<dt id="ein:url-or-port">
<em class="property">variable </em><tt class="descname">ein:url-or-port</tt><a class="headerlink" href="#ein:url-or-port" title="Permalink to this definition"></a></dt>
@ -989,7 +1032,7 @@ Notebook server.</p>
</div>
<div class="section" id="id8">
<h3><a class="toc-backref" href="#id33">Notebook</a><a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id37">Notebook</a><a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<dl class="variable">
<dt id="ein:notebook-enable-undo">
<em class="property">variable </em><tt class="descname">ein:notebook-enable-undo</tt><a class="headerlink" href="#ein:notebook-enable-undo" title="Permalink to this definition"></a></dt>
@ -1119,10 +1162,10 @@ using the command <tt class="xref el el-symbol docutils literal"><span class="pr
</dd></dl>
<dl class="variable">
<dt id="ein:cell-max-num-outputs">
<em class="property">variable </em><tt class="descname">ein:cell-max-num-outputs</tt><a class="headerlink" href="#ein:cell-max-num-outputs" title="Permalink to this definition"></a></dt>
<dd><p>Number of maximum outputs to be shown by default.
To view full output, use <tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebook-show-in-shared-output</span></tt>.</p>
<dt id="ein:cell-autoexec-prompt">
<em class="property">variable </em><tt class="descname">ein:cell-autoexec-prompt</tt><a class="headerlink" href="#ein:cell-autoexec-prompt" title="Permalink to this definition"></a></dt>
<dd><p>String shown in the cell prompt when the auto-execution flag
is on. See also <a class="reference internal" href="#ein:connect-aotoexec-lighter" title="ein:connect-aotoexec-lighter"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-aotoexec-lighter</span></tt></a>.</p>
</dd></dl>
<dl class="variable">
@ -1135,14 +1178,23 @@ format string which can be passed to <tt class="xref el el-symbol docutils liter
</dd></dl>
<dl class="variable">
<dt id="ein:autoexec-delay">
<em class="property">variable </em><tt class="descname">ein:autoexec-delay</tt><a class="headerlink" href="#ein:autoexec-delay" title="Permalink to this definition"></a></dt>
<dt id="ein:iexec-delay">
<em class="property">variable </em><tt class="descname">ein:iexec-delay</tt><a class="headerlink" href="#ein:iexec-delay" title="Permalink to this definition"></a></dt>
<dd><p>Delay before executing cell after change in second.</p>
</dd></dl>
<dl class="variable">
<dt id="ein:complete-on-dot">
<em class="property">variable </em><tt class="descname">ein:complete-on-dot</tt><a class="headerlink" href="#ein:complete-on-dot" title="Permalink to this definition"></a></dt>
<dd><p>Start completion when inserting a dot. Note that
<a class="reference internal" href="#ein:use-auto-complete" title="ein:use-auto-complete"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:use-auto-complete</span></tt></a> (or <a class="reference internal" href="#ein:use-auto-complete-superpack" title="ein:use-auto-complete-superpack"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:use-auto-complete-superpack</span></tt></a>)
must be <tt class="xref el el-symbol docutils literal"><span class="pre">t</span></tt> to enable this option. This variable has effect on
notebook buffers and connected buffers.</p>
</dd></dl>
</div>
<div class="section" id="connect">
<h3><a class="toc-backref" href="#id34">Connect</a><a class="headerlink" href="#connect" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id38">Connect</a><a class="headerlink" href="#connect" title="Permalink to this headline"></a></h3>
<dl class="variable">
<dt id="ein:connect-run-command">
<em class="property">variable </em><tt class="descname">ein:connect-run-command</tt><a class="headerlink" href="#ein:connect-run-command" title="Permalink to this definition"></a></dt>
@ -1162,9 +1214,17 @@ Types same as <a class="reference internal" href="#ein:notebook-console-security
<dd><p>Set to <tt class="xref el el-symbol docutils literal"><span class="pre">t</span></tt> to connect to the notebook after jumping to a buffer.</p>
</dd></dl>
<dl class="variable">
<dt id="ein:connect-aotoexec-lighter">
<em class="property">variable </em><tt class="descname">ein:connect-aotoexec-lighter</tt><a class="headerlink" href="#ein:connect-aotoexec-lighter" title="Permalink to this definition"></a></dt>
<dd><p>String appended to the lighter of <tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-mode</span></tt> (<tt class="xref el el-symbol docutils literal"><span class="pre">ein:c</span></tt>)
when auto-execution mode is on. When <tt class="xref el el-symbol docutils literal"><span class="pre">nil</span></tt>, use the same string
as <a class="reference internal" href="#ein:cell-autoexec-prompt" title="ein:cell-autoexec-prompt"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:cell-autoexec-prompt</span></tt></a>.</p>
</dd></dl>
</div>
<div class="section" id="id9">
<h3><a class="toc-backref" href="#id35">MuMaMo</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id39">MuMaMo</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<dl class="variable">
<dt id="ein:mumamo-codecell-mode">
<em class="property">variable </em><tt class="descname">ein:mumamo-codecell-mode</tt><a class="headerlink" href="#ein:mumamo-codecell-mode" title="Permalink to this definition"></a></dt>
@ -1223,8 +1283,58 @@ problem.</p>
</dd></dl>
</div>
<div class="section" id="misc">
<h3><a class="toc-backref" href="#id36">Misc</a><a class="headerlink" href="#misc" title="Permalink to this headline"></a></h3>
<div class="section" id="id10">
<h3><a class="toc-backref" href="#id40">Misc</a><a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<dl class="variable">
<dt id="ein:filename-translations">
<em class="property">variable </em><tt class="descname">ein:filename-translations</tt><a class="headerlink" href="#ein:filename-translations" title="Permalink to this definition"></a></dt>
<dd><p>Convert file paths between Emacs and Python process.</p>
<p>This value can take these form:</p>
<dl class="docutils">
<dt>alist</dt>
<dd>Its key specifies URL-OR-PORT and value must be a list of two
functions: (TO-PYTHON FROM-PYTHON). Key (URL-OR-PORT) can be
string (URL), integer (port), or <tt class="xref el el-symbol docutils literal"><span class="pre">default</span></tt> (symbol). The
value of <tt class="xref el el-symbol docutils literal"><span class="pre">default</span></tt> is used when other key does not much.</dd>
<dt>function</dt>
<dd>Called with an argument URL-OR-PORT (integer or string).
This function must return a list of two functions:
(TO-PYTHON FROM-PYTHON).</dd>
</dl>
<p>Here, the functions TO-PYTHON and FROM-PYTHON are defined as:</p>
<dl class="docutils">
<dt>TO-PYTHON</dt>
<dd>A function which converts a file name (returned by
<tt class="xref el el-symbol docutils literal"><span class="pre">buffer-file-name</span></tt>) to the one Python understands.</dd>
<dt>FROM-PYTHON</dt>
<dd>A function which converts a file path returned by
Python process to the one Emacs understands.</dd>
</dl>
<p>Use <a class="reference internal" href="#ein:tramp-create-filename-translator" title="ein:tramp-create-filename-translator"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:tramp-create-filename-translator</span></tt></a> to easily generate the
pair of TO-PYTHON and FROM-PYTHON.</p>
</dd></dl>
<dl class="function">
<dt id="ein:tramp-create-filename-translator">
<em class="property">function </em><big>(</big><tt class="descname">ein:tramp-create-filename-translator </tt><em>remote-host</em> <em>&amp;optional</em> <em>username</em><big>)</big><a class="headerlink" href="#ein:tramp-create-filename-translator" title="Permalink to this definition"></a></dt>
<dd><p>Generate a pair of TO-PYTHON and FROM-PYTHON for
<a class="reference internal" href="#ein:filename-translations" title="ein:filename-translations"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:filename-translations</span></tt></a>.</p>
<p>Usage:</p>
<div class="highlight-python"><pre>(setq ein:filename-translations
`((8888
. ,(ein:tramp-create-filename-translator "MY-HOSTNAME"))))
;; Equivalently:
(setq ein:filename-translations
(lambda (url-or-port)
(when (equal url-or-port 8888)
(ein:tramp-create-filename-translator "MY-HOSTNAME"))))</pre>
</div>
<p>This setting assumes that the IPython server which can be
connected using the port 8888 in localhost is actually running in
the host named MY-HOSTNAME.</p>
<p>Adapted from <tt class="xref el el-symbol docutils literal"><span class="pre">slime-create-filename-translator</span></tt>.</p>
</dd></dl>
<dl class="variable">
<dt id="ein:query-timeout">
<em class="property">variable </em><tt class="descname">ein:query-timeout</tt><a class="headerlink" href="#ein:query-timeout" title="Permalink to this definition"></a></dt>
@ -1249,14 +1359,14 @@ let me know or send pull request at github!
</div>
</div>
<div class="section" id="gotchas-and-caveats">
<h2><a class="toc-backref" href="#id37">Gotchas and caveats</a><a class="headerlink" href="#gotchas-and-caveats" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id41">Gotchas and caveats</a><a class="headerlink" href="#gotchas-and-caveats" title="Permalink to this headline"></a></h2>
<p>Although EIN mostly works fine, there are some deficits I noticed but
have not fixed yet. It seems that they originate from some upstream
bugs so there is little I can do in EIN (but I&#8217;m not sure &#8211; it&#8217;s
possible that I am misusing the libraries!).</p>
<p>If you know how to fix/workaround them, patches are very welcome.</p>
<div class="section" id="url-retrieve">
<h3><a class="toc-backref" href="#id38"><tt class="xref el el-symbol docutils literal"><span class="pre">url-retrieve</span></tt></a><a class="headerlink" href="#url-retrieve" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id42"><tt class="xref el el-symbol docutils literal"><span class="pre">url-retrieve</span></tt></a><a class="headerlink" href="#url-retrieve" title="Permalink to this headline"></a></h3>
<p>While using EIN, probably most of the error messages are about server
connections. It looks like the problem is in <tt class="xref el el-symbol docutils literal"><span class="pre">url-retrieve</span></tt>.
But in those cases you don&#8217;t loose any notebook data and your IPython
@ -1265,23 +1375,23 @@ fine most of the time. For saving notebook, I implemented code to
retry when there is an error comes from <tt class="xref el el-symbol docutils literal"><span class="pre">url-retrieve</span></tt> to
make it even safer.</p>
</div>
<div class="section" id="id10">
<h3><a class="toc-backref" href="#id39">MuMaMo</a><a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<div class="section" id="id11">
<h3><a class="toc-backref" href="#id43">MuMaMo</a><a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<p>When using MuMaMo based notebook mode, you will notice that
highlighting outside of the cell input is turned off while you are in
the input area. It seems there is a bug in MuMaMo <a class="footnote-reference" href="#m3bug" id="id11">[4]</a>.</p>
the input area. It seems there is a bug in MuMaMo <a class="footnote-reference" href="#m3bug" id="id12">[4]</a>.</p>
<p>If you are using smartrep and MuMaMo together, see also the warning in
<a class="reference internal" href="#ein:use-smartrep" title="ein:use-smartrep"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:use-smartrep</span></tt></a> document.</p>
<table class="docutils footnote" frame="void" id="m3bug" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id11">[4]</a></td><td>See the relevant bug report I posted:
<tr><td class="label"><a class="fn-backref" href="#id12">[4]</a></td><td>See the relevant bug report I posted:
<a class="reference external" href="https://bugs.launchpad.net/nxhtml/+bug/1013794">https://bugs.launchpad.net/nxhtml/+bug/1013794</a></td></tr>
</tbody>
</table>
</div>
<div class="section" id="gotchas-python-mode-el">
<span id="id12"></span><h3><a class="toc-backref" href="#id40">python-mode.el</a><a class="headerlink" href="#gotchas-python-mode-el" title="Permalink to this headline"></a></h3>
<span id="id13"></span><h3><a class="toc-backref" href="#id44">python-mode.el</a><a class="headerlink" href="#gotchas-python-mode-el" title="Permalink to this headline"></a></h3>
<p>In my environment, using <a class="reference external" href=":https://launchpad.net/python-mode">python-mode.el</a> without byte-compiling it
in MuMaMo based notebook mode produces segfault.</p>
<p>Also, <tt class="docutils literal"><span class="pre">mumamo-idle-set-major-mode</span></tt> messages error
@ -1290,7 +1400,7 @@ time to time, making minibuffer bit noisy while editing notebook.</p>
</div>
</div>
<div class="section" id="advanced">
<h2><a class="toc-backref" href="#id41">Advanced</a><a class="headerlink" href="#advanced" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id45">Advanced</a><a class="headerlink" href="#advanced" title="Permalink to this headline"></a></h2>
<p>By telling IPython a little bit about Emacs Lisp, you can execute
Emacs Lisp from IPython, just like you can execute Javascript in the
web client. See <a class="reference external" href="https://github.com/tkf/emacs-ipython-notebook/blob/master/emacslisp.py">emacslisp.py</a> for more details.</p>
@ -1305,9 +1415,9 @@ web client. See <a class="reference external" href="https://github.com/tkf/emac
</div>
</div>
<div class="section" id="reporting-issue">
<h2><a class="toc-backref" href="#id42">Reporting issue</a><a class="headerlink" href="#reporting-issue" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id46">Reporting issue</a><a class="headerlink" href="#reporting-issue" title="Permalink to this headline"></a></h2>
<div class="section" id="logging">
<h3><a class="toc-backref" href="#id43">Logging</a><a class="headerlink" href="#logging" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id47">Logging</a><a class="headerlink" href="#logging" title="Permalink to this headline"></a></h3>
<p>Sometime more information that the <tt class="docutils literal"><span class="pre">*Message*</span></tt> buffer provides is
needed to debug.</p>
<ol class="arabic">
@ -1331,8 +1441,8 @@ a code block, like this:</p>
<a class="reference external" href="https://gist.github.com/">gist</a>.</p>
</li>
</ol>
<div class="section" id="id13">
<h4><a class="toc-backref" href="#id44">websocket.el</a><a class="headerlink" href="#id13" title="Permalink to this headline"></a></h4>
<div class="section" id="id14">
<h4><a class="toc-backref" href="#id48">websocket.el</a><a class="headerlink" href="#id14" title="Permalink to this headline"></a></h4>
<p>websocket.el has its logging buffer. Sometime its useful to see its
log. This is how to do that.</p>
<ol class="arabic simple">
@ -1347,7 +1457,7 @@ These command must be called in the notebook buffer.</li>
</div>
</div>
<div class="section" id="debugging">
<h3><a class="toc-backref" href="#id45">Debugging</a><a class="headerlink" href="#debugging" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id49">Debugging</a><a class="headerlink" href="#debugging" title="Permalink to this headline"></a></h3>
<p>If you are interested in debugging EIN, you should start it with
calling the command <tt class="xref el el-symbol docutils literal"><span class="pre">ein:dev-start-debug</span></tt>.
This command sets <tt class="xref el el-symbol docutils literal"><span class="pre">debug-on-error</span></tt> to <tt class="docutils literal"><span class="pre">t</span></tt> and do some
@ -1359,40 +1469,54 @@ with <tt class="xref el el-symbol docutils literal"><span class="pre">ein:dev-st
</div>
</div>
<div class="section" id="change-log">
<h1><a class="toc-backref" href="#id46">Change Log</a><a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id50">Change Log</a><a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<div class="section" id="v0-1-1">
<h2><a class="toc-backref" href="#id47">v0.1.1</a><a class="headerlink" href="#v0-1-1" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id51">v0.1.1</a><a class="headerlink" href="#v0-1-1" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Support <a class="reference external" href="http://cx4a.org/software/auto-complete/">auto-complete.el</a>&#8216;s popup/quick help.</li>
<li>Add <tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebooklist-first-open-hook</span></tt>.</li>
<li><a class="reference internal" href="#ein:connect-to-notebook" title="ein:connect-to-notebook"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-to-notebook</span></tt></a> is improved; it can connect to
the notebook which is not opened yet.</li>
<li>Handle carriage return
(<a class="reference external" href="https://github.com/tkf/emacs-ipython-notebook/issues/13">#13</a>).</li>
<li><a class="reference internal" href="#ein:connect-to-notebook-command" title="ein:connect-to-notebook-command"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-to-notebook-command</span></tt></a> is improved;
it can connect to the notebook which is not opened yet.</li>
<li>Plain text type output is favored over LaTeX type output
(previous setting was opposite).</li>
<li>Workaround indentation problem when using MuMaMo
(<a class="reference external" href="https://github.com/tkf/emacs-ipython-notebook/issues/20">#20</a>).
See <a class="reference internal" href="#ein:use-mumamo-indent-line-function-workaround" title="ein:use-mumamo-indent-line-function-workaround"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:use-mumamo-indent-line-function-workaround</span></tt></a>.</li>
<li>Add <a class="reference internal" href="#ein:notebook-rename-to-scratch-command" title="ein:notebook-rename-to-scratch-command"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebook-rename-to-scratch-command</span></tt></a>.</li>
<li>Introduce <tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebook-show-in-shared-output</span></tt> command
and <a class="reference internal" href="#ein:cell-max-num-outputs" title="ein:cell-max-num-outputs"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:cell-max-num-outputs</span></tt></a> configuration variable to
truncate long output and show it in a separated buffer.</li>
<li>Add <a class="reference internal" href="#ein:pytools-pandas-to-ses" title="ein:pytools-pandas-to-ses"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:pytools-pandas-to-ses</span></tt></a>.</li>
<li>Add Imenu support.</li>
<li>Better heading cell faces.</li>
<li>Add <a class="reference internal" href="#ein:autoexec-mode" title="ein:autoexec-mode"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:autoexec-mode</span></tt></a></li>
<li>Add <a class="reference internal" href="#ein:iexec-mode" title="ein:iexec-mode"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:iexec-mode</span></tt></a></li>
<li>Add auto-execution mode
(see <tt class="xref el el-symbol docutils literal"><span class="pre">ein:connect-toggle-autoexec</span></tt> and
<tt class="xref el el-symbol docutils literal"><span class="pre">ein:notebook-turn-on-autoexec</span></tt>).</li>
<li>Start completion when &#8221;.&#8221; is inserted.
Use <a class="reference internal" href="#ein:complete-on-dot" title="ein:complete-on-dot"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:complete-on-dot</span></tt></a> to disable this feature.</li>
<li>Support tramp. See <a class="reference internal" href="#ein:filename-translations" title="ein:filename-translations"><tt class="xref el el-symbol docutils literal"><span class="pre">ein:filename-translations</span></tt></a>.</li>
<li>Change callback API in <tt class="xref el el-symbol docutils literal"><span class="pre">ein:kernel-execute</span></tt>
to adapt messaging protocol change in
<a class="reference external" href="https://github.com/ipython/ipython/pull/2051">IPython (#2051)</a>.</li>
<li>Add helm/anything support.
Use <a class="reference internal" href="#helm-ein-notebook-buffers" title="helm-ein-notebook-buffers"><tt class="xref el el-symbol docutils literal"><span class="pre">helm-ein-notebook-buffers</span></tt></a> or
<a class="reference internal" href="#anything-ein-notebook-buffers" title="anything-ein-notebook-buffers"><tt class="xref el el-symbol docutils literal"><span class="pre">anything-ein-notebook-buffers</span></tt></a>.</li>
</ul>
</div>
<div class="section" id="v0-1">
<h2><a class="toc-backref" href="#id48">v0.1</a><a class="headerlink" href="#v0-1" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id52">v0.1</a><a class="headerlink" href="#v0-1" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>First release.</li>
</ul>
</div>
</div>
<div class="section" id="license">
<h1><a class="toc-backref" href="#id49">License</a><a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id53">License</a><a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
<p>Emacs IPython Notebook is licensed under GPL v3.
See COPYING for details.</p>
</div>
<div class="section" id="indices-and-tables">
<h1><a class="toc-backref" href="#id50">Indices and tables</a><a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id54">Indices and tables</a><a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
@ -1410,7 +1534,7 @@ See COPYING for details.</p>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="#">Emacs IPython Notebook 0.1.1alpha0 documentation</a> &raquo;</li>
<li><a href="#">Emacs IPython Notebook 0.1.2alpha0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

2
objects.inv
View file

@ -1,6 +1,6 @@
# Sphinx inventory version 2
# Project: Emacs IPython Notebook
# Version: 0.1.1
# Version: 0.1.2
# The remainder of this file is compressed using zlib.
xÚ•ŽA
Â0E÷9Å€nSpë \(‚'H“!)&™âŒÐÞÞ†F4Pî†?ïñ¿Ç<d‡°¸c4=FÐð5키¸ƒS¹U"·<>Ž³~?*}&÷ŒX%Fó°¡UÖ¬Ò·¸<1A>*“`Ot×–R2Ùqë}•ìáRYåIl0¬ÇYå2»…ÿenàz<C3A0>Zû³$,ÿÌ<C3BF>"¨5y<>

10
search.html
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; Emacs IPython Notebook 0.1.1alpha0 documentation</title>
<title>Search &mdash; Emacs IPython Notebook 0.1.2alpha0 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.1.1alpha0',
VERSION: '0.1.2alpha0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -25,7 +25,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.1.1alpha0 documentation" href="index.html" />
<link rel="top" title="Emacs IPython Notebook 0.1.2alpha0 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
@ -39,7 +39,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">Emacs IPython Notebook 0.1.1alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.1.2alpha0 documentation</a> &raquo;</li>
</ul>
</div>
@ -81,7 +81,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">Emacs IPython Notebook 0.1.1alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.1.2alpha0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

2
searchindex.js
View file

File diff suppressed because one or more lines are too long