This commit is contained in:
Takafumi Arakaki 2012-08-24 00:05:03 +02:00
parent c5d91e3649
commit ff82393ed3
6 changed files with 389 additions and 223 deletions

View file

@ -3,8 +3,8 @@ Welcome to Emacs IPython Notebook's documentation!
.. el:package:: ein
Emacs IPython Notebook (EIN) provides fully featured IPython Notebook
client and integrated REPL (like SLIME_). While EIN makes notebook
Emacs IPython Notebook (EIN) provides a IPython Notebook client and
integrated REPL (like SLIME_) in Emacs. While EIN makes notebook
editing very powerful by allowing you to use any Emacs features, it
also expose IPython features such as code evaluation, object
inspection and code completion to the Emacs side. These features can
@ -42,8 +42,15 @@ Links:
* `Online Documentation
<http://tkf.github.com/emacs-ipython-notebook/>`_
* `Screenshots
<https://github.com/tkf/emacs-ipython-notebook/wiki/Screenshots>`_
* `Wiki
<https://github.com/tkf/emacs-ipython-notebook/wiki>`_
+ `Screenshots
<https://github.com/tkf/emacs-ipython-notebook/wiki/Screenshots>`_
+ `Tips
<https://github.com/tkf/emacs-ipython-notebook/wiki/Tips>`_
* `Downloads
<https://github.com/tkf/emacs-ipython-notebook/tags>`_
* `Repository at GitHub
@ -51,7 +58,7 @@ Links:
* `Issue Tracker at GitHub
<https://github.com/tkf/emacs-ipython-notebook/issues>`_
.. [#] You need to setup :el:symbol:`ein:notebook-console-args` properly
.. [#] You need to setup :el:symbol:`ein:console-args` properly
.. [#] Use the command :el:symbol:`ein:connect-to-notebook-command`.
.. contents::
@ -84,7 +91,7 @@ Requirements
* (optional) python-mode:
It should work with either python.el or `python-mode.el`_ [#]_.
Fabian Gallina's `python.el`_ is required to use
:el:symbol:`ein:notebook-console-open` command.
:el:symbol:`ein:console-open` command.
* (optional) `auto-complete.el`_
You need to configure :el:symbol:`ein:use-auto-complete` to enable
this feature.
@ -113,6 +120,11 @@ EIEIO and json.el. EIN is currently tested in Emacs 24.1.
Install
-------
.. warning:: As EIN relies on many packages and it will not work
properly with outdated versions, installing it using el-get or
MELPA is highly recommended.
Using el-get
^^^^^^^^^^^^
@ -217,7 +229,7 @@ The following keybinds are available in notebook buffers.
.. el:keymap:: ein:notebook-mode-map
.. el:function:: ein:notebook-delete-cell-command
.. el:function:: ein:worksheet-delete-cell
.. el:function:: ein:notebook-rename-to-scratch-command
.. el:function:: ein:notebook-kill-all-buffers
.. el:function:: ein:iexec-mode
@ -310,19 +322,24 @@ Notebook
.. el:variable:: ein:notebook-kill-buffer-ask
.. el:variable:: ein:notebook-querty-timeout-open
.. el:variable:: ein:notebook-querty-timeout-save
.. el:variable:: ein:notebook-console-security-dir
.. el:variable:: ein:notebook-console-executable
.. el:variable:: ein:notebook-console-args
.. el:variable:: ein:cell-traceback-level
.. el:variable:: ein:cell-autoexec-prompt
.. el:variable:: ein:scratch-notebook-name-template
.. el:variable:: ein:iexec-delay
.. el:variable:: ein:complete-on-dot
Console
^^^^^^^
.. el:variable:: ein:console-security-dir
.. el:variable:: ein:console-executable
.. el:variable:: ein:console-args
Connect
^^^^^^^
.. el:variable:: ein:connect-run-command
.. el:variable:: ein:connect-reload-command
.. el:variable:: ein:connect-save-before-run
.. el:variable:: ein:propagate-connect
.. el:variable:: ein:connect-aotoexec-lighter
@ -475,6 +492,29 @@ with :el:symbol:`ein:dev-stop-debug`.
Change Log
==========
v0.2
----
* Add :el:symbol:`ein:worksheet-execute-cell-and-insert-below`.
* Change the timing to trigger auto-execution in connected buffer.
It was triggered on save before. Now it is on run, eval or reload.
See :el:symbol:`ein:connect-toggle-autoexec`.
* [WIP] Worksheet support.
v0.1.2
------
* Mostly refactoring for worksheet support in v0.2.
* Rename command :el:symbol:`ein:notebook-console-open` to
:el:symbol:`ein:console-open`. It is available from non-notebook
buffer such as connected buffer now.
* Add :el:symbol:`ein:connect-reload-buffer`.
Old default :el:symbol:`ein:connect-run-buffer` behavior is
replaced by this function. :el:symbol:`ein:connect-run-buffer`
now actually runs buffer instead of loading it.
v0.1.1
------

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.2alpha0 documentation</title>
<title>Index &mdash; Emacs IPython Notebook 0.2.0alpha0 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.2alpha0',
VERSION: '0.2.0alpha0',
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.2alpha0 documentation" href="index.html" />
<link rel="top" title="Emacs IPython Notebook 0.2.0alpha0 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.2alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.2.0alpha0 documentation</a> &raquo;</li>
</ul>
</div>
@ -90,6 +90,10 @@
</dt>
<dt><a href="index.html#ein:connect-reload-command">ein:connect-reload-command (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:connect-run-buffer">ein:connect-run-buffer (Lisp function)</a>
</dt>
@ -106,6 +110,18 @@
</dt>
<dt><a href="index.html#ein:console-args">ein:console-args (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:console-executable">ein:console-executable (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:console-security-dir">ein:console-security-dir (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:default-url-or-port">ein:default-url-or-port (Lisp variable)</a>
</dt>
@ -154,28 +170,12 @@
</dt>
<dt><a href="index.html#ein:notebook-console-args">ein:notebook-console-args (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:notebook-console-executable">ein:notebook-console-executable (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:notebook-console-security-dir">ein:notebook-console-security-dir (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:notebook-delete-cell-command">ein:notebook-delete-cell-command (Lisp function)</a>
<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-discard-output-on-save">ein:notebook-discard-output-on-save (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:notebook-enable-undo">ein:notebook-enable-undo (Lisp variable)</a>
</dt>
@ -275,6 +275,10 @@
<dt><a href="index.html#ein:use-smartrep">ein:use-smartrep (Lisp variable)</a>
</dt>
<dt><a href="index.html#ein:worksheet-delete-cell">ein:worksheet-delete-cell (Lisp function)</a>
</dt>
</dl></td>
</tr></table>
@ -300,7 +304,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.2alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.2.0alpha0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

File diff suppressed because it is too large Load diff

View file

@ -1,6 +1,6 @@
# Sphinx inventory version 2
# Project: Emacs IPython Notebook
# Version: 0.1.2
# Version: 0.2.0
# 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<>

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.2alpha0 documentation</title>
<title>Search &mdash; Emacs IPython Notebook 0.2.0alpha0 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.2alpha0',
VERSION: '0.2.0alpha0',
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.2alpha0 documentation" href="index.html" />
<link rel="top" title="Emacs IPython Notebook 0.2.0alpha0 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.2alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.2.0alpha0 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.2alpha0 documentation</a> &raquo;</li>
<li><a href="index.html">Emacs IPython Notebook 0.2.0alpha0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

File diff suppressed because one or more lines are too long