From ff82393ed322588b3ea093f1c38155d47d0494c1 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Fri, 24 Aug 2012 00:05:03 +0200 Subject: [PATCH] Update --- _sources/index.txt | 60 +++++- genindex.html | 48 +++-- index.html | 490 ++++++++++++++++++++++++++++----------------- objects.inv | 2 +- search.html | 10 +- searchindex.js | 2 +- 6 files changed, 389 insertions(+), 223 deletions(-) diff --git a/_sources/index.txt b/_sources/index.txt index dc0dcca..aae685c 100644 --- a/_sources/index.txt +++ b/_sources/index.txt @@ -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 `_ -* `Screenshots - `_ + +* `Wiki + `_ + + + `Screenshots + `_ + + `Tips + `_ + * `Downloads `_ * `Repository at GitHub @@ -51,7 +58,7 @@ Links: * `Issue Tracker at GitHub `_ -.. [#] 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 ------ diff --git a/genindex.html b/genindex.html index e86a9fb..4e9a46e 100644 --- a/genindex.html +++ b/genindex.html @@ -9,7 +9,7 @@ - Index — Emacs IPython Notebook 0.1.2alpha0 documentation + Index — Emacs IPython Notebook 0.2.0alpha0 documentation @@ -17,7 +17,7 @@ - +
@@ -35,7 +35,7 @@
  • index
    • -
  • Emacs IPython Notebook 0.1.2alpha0 documentation »
    • +
  • Emacs IPython Notebook 0.2.0alpha0 documentation »
    • @@ -90,6 +90,10 @@ +
    ein:connect-reload-command (Lisp variable) +
    + +
    ein:connect-run-buffer (Lisp function)
    @@ -106,6 +110,18 @@ +
    ein:console-args (Lisp variable) +
    + + +
    ein:console-executable (Lisp variable) +
    + + +
    ein:console-security-dir (Lisp variable) +
    + +
    ein:default-url-or-port (Lisp variable)
    @@ -154,28 +170,12 @@ -
    ein:notebook-console-args (Lisp variable) -
    - - -
    ein:notebook-console-executable (Lisp variable) -
    - - -
    ein:notebook-console-security-dir (Lisp variable) -
    - - -
    ein:notebook-delete-cell-command (Lisp function) +
    ein:notebook-discard-output-on-save (Lisp variable)
    -
    ein:notebook-discard-output-on-save (Lisp variable) -
    - -
    ein:notebook-enable-undo (Lisp variable)
    @@ -275,6 +275,10 @@
    ein:use-smartrep (Lisp variable)
    + +
    ein:worksheet-delete-cell (Lisp function) +
    +
    @@ -300,7 +304,7 @@
  • index
    • -
  • Emacs IPython Notebook 0.1.2alpha0 documentation »
    • +
  • Emacs IPython Notebook 0.2.0alpha0 documentation »
    • diff --git a/index.html b/index.html index 5b37e4a..d1a174f 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@ - Welcome to Emacs IPython Notebook’s documentation! — Emacs IPython Notebook 0.1.2alpha0 documentation + Welcome to Emacs IPython Notebook’s documentation! — Emacs IPython Notebook 0.2.0alpha0 documentation @@ -15,7 +15,7 @@ - +
    @@ -33,7 +33,7 @@
  • index
    • -
  • Emacs IPython Notebook 0.1.2alpha0 documentation »
    • +
  • Emacs IPython Notebook 0.2.0alpha0 documentation »
    • @@ -42,9 +42,9 @@
    -

    Welcome to Emacs IPython Notebook’s documentation!

    -

    Emacs IPython Notebook (EIN) provides fully featured IPython Notebook -client and integrated REPL (like SLIME). While EIN makes notebook +

    Welcome to Emacs IPython Notebook’s documentation!

    +

    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 @@ -75,7 +75,11 @@ object).

    Links:

    -

    Install

    +

    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

    +

    Using el-get

    If you use developmental version of el-get, you can install it easily using it. Emacs IPython Notebook is registered as package ein. See el-get website for more information.

    @@ -213,12 +226,12 @@ will solve the problem. Note that this will remove the whole
    -

    Using package.el (MELPA)

    +

    Using package.el (MELPA)

    You can install EIN using package.el when MELPA package repository is added to its setting. See MELPA website for more information.

    -

    Manual install

    +

    Manual install

    Put Emacs lisp ein*.el files and Python file ein.py in a directory defined in your load-path.

    You should byte compile EIN, especially when using MuMaMo, otherwise @@ -239,7 +252,7 @@ don’t use that optional package.

    -

    Setup

    +

    Setup

    Here is the minimal configuration. See customization for more details.

    (require 'ein)
    @@ -247,7 +260,7 @@ don’t use that optional package.

    -

    Usage

    +

    Usage

    1. Start IPython notebook server.
    2. Hit M-x ein:notebooklist-open to open notebook list. This will @@ -258,9 +271,9 @@ section for what you can do in the notebook buffer.
    -

    Commands/Keybinds

    +

    Commands/Keybinds

    -

    Notebook list

    +

    Notebook list

    You can start notebook by M-x ein:notebooklist-open and enter the port or URL of the IPython notebook server.

    @@ -346,19 +359,19 @@ Notebook name is determined based on
    -

    Notebook

    +

    Notebook

    The following keybinds are available in notebook buffers.

    -C-c C-c ein:notebook-execute-current-cell
    +C-c C-c ein:worksheet-execute-cell -

    Execute cell at point.

    +

    Execute code type CELL.

    -C-c C-' ein:notebook-turn-on-autoexec
    +C-c C-' ein:worksheet-turn-on-autoexec

    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.

    @@ -370,7 +383,7 @@ command.

    -C-c C-e ein:notebook-toggle-output-command
    +C-c C-e ein:worksheet-toggle-output

    Toggle the visibility of the output of the cell at point. This does not alter the actual data stored in the cell.

    @@ -379,7 +392,7 @@ This does not alter the actual data stored in the cell.

    -C-c C-v ein:notebook-set-collapsed-all-command
    +C-c C-v ein:worksheet-set-collapsed-all

    Hide all cell output. When prefix is given, show all cell output.

    @@ -387,7 +400,7 @@ This does not alter the actual data stored in the cell.

    -C-c C-l ein:notebook-clear-output-command
    +C-c C-l ein:worksheet-clear-output

    Clear output from the current cell at point. Do not clear input prompt when the prefix argument is given.

    @@ -396,7 +409,7 @@ Do not clear input prompt when the prefix argument is given.

    -C-c C-S-l ein:notebook-clear-all-output-command
    +C-c C-S-l ein:worksheet-clear-all-output

    Clear output from all cells. Do not clear input prompts when the prefix argument is given.

    @@ -405,19 +418,19 @@ Do not clear input prompts when the prefix argument is given.

    -C-c C-; ein:notebook-show-in-shared-output
    +C-c C-; ein:shared-output-show-code-cell-at-point -

    Show truncated code cell ouput in shared-output buffer. -See also ein:cell-max-num-outputs to how to truncate long -output.

    +

    Show code cell at point in shared-output buffer. +It is useful when the output of the cell at point is truncated. +See also ein:cell-max-num-outputs.

    -C-c C-k ein:notebook-kill-cell-command
    +C-c C-k ein:worksheet-kill-cell -

    Kill (“cut”) the cell at point. +

    Kill (“cut”) the cell at point or cells in region. Note that the kill-ring for cells is not shared with the default kill-ring of Emacs (kill-ring for texts).

    @@ -425,7 +438,7 @@ kill-ring of Emacs (kill-ring for texts).

    -C-c M-w ein:notebook-copy-cell-command
    +C-c M-w ein:worksheet-copy-cell

    Copy the cell at point. (Put the current cell into the kill-ring.)

    @@ -433,7 +446,7 @@ kill-ring of Emacs (kill-ring for texts).

    -C-c C-w ein:notebook-copy-cell-command
    +C-c C-w ein:worksheet-copy-cell

    Copy the cell at point. (Put the current cell into the kill-ring.)

    @@ -441,7 +454,7 @@ kill-ring of Emacs (kill-ring for texts).

    -C-c C-y ein:notebook-yank-cell-command
    +C-c C-y ein:worksheet-yank-cell

    Insert (“paste”) the latest killed cell. Prefixes are act same as the normal yank command.

    @@ -450,35 +463,38 @@ Prefixes are act same as the normal
    -C-c C-a ein:notebook-insert-cell-above-command
    +C-c C-a ein:worksheet-insert-cell-above

    Insert cell above. Insert markdown cell instead of code cell -when the prefix argument is given.

    +when the prefix argument is given. +See also: ein:worksheet-insert-cell-below.

    -C-c C-b ein:notebook-insert-cell-below-command
    +C-c C-b ein:worksheet-insert-cell-below

    Insert cell below. Insert markdown cell instead of code cell when the prefix argument is given.

    +

    When used as a lisp function, insert a cell of TYPE-OR-CELL just +after PIVOT and return the new cell.

    -C-c C-t ein:notebook-toggle-cell-type
    +C-c C-t ein:worksheet-toggle-cell-type

    Toggle the cell type of the cell at point. -Use ein:notebook-change-cell-type to change the cell type +Use ein:worksheet-change-cell-type to change the cell type directly.

    -C-c C-u ein:notebook-change-cell-type
    +C-c C-u ein:worksheet-change-cell-type

    Change the cell type of the current cell. Prompt will appear in the minibuffer.

    @@ -490,7 +506,7 @@ an integer used only when the TYPE is “heading”.

    -C-c C-s ein:notebook-split-cell-at-point
    +C-c C-s ein:worksheet-split-cell-at-point

    Split cell at current position. Newlines at the splitting point will be removed. This can be omitted by giving a prefix @@ -500,7 +516,7 @@ argument (C-u).

    -C-c RET ein:notebook-merge-cell-command
    +C-c RET ein:worksheet-merge-cell

    Merge previous cell into current cell. If prefix is given, merge current cell into next cell.

    @@ -509,27 +525,27 @@ If prefix is given, merge current cell into next cell.

    -C-c C-n ein:notebook-goto-next-input-command
    +C-c C-n ein:worksheet-goto-next-input
    -C-c C-p ein:notebook-goto-prev-input-command
    +C-c C-p ein:worksheet-goto-prev-input
    -C-c <up> ein:notebook-move-cell-up-command
    +C-c <up> ein:worksheet-move-cell-up
    -C-c <down> ein:notebook-move-cell-down-command
    +C-c <down> ein:worksheet-move-cell-down
    -C-c C-f ein:notebook-request-tool-tip-or-help-command
    +C-c C-f ein:pytools-request-tooltip-or-help

    Show the help for the object at point using tooltip. When the prefix argument C-u is given, open the help in the @@ -539,14 +555,14 @@ pager buffer. You can explicitly specify the object by selecting it.

    -C-c TAB ein:notebook-complete-command
    +C-c TAB ein:completer-complete
    -C-c C-x ein:notebook-view-traceback
    +C-c C-x ein:tb-show -

    Open traceback viewer for the traceback at point.

    +

    Popup traceback viewer.

    @@ -579,11 +595,11 @@ as usual.

    -C-c C-o ein:notebook-console-open
    +C-c C-o ein:console-open

    Open IPython console. -To use this function, ein:notebook-console-security-dir and -ein:notebook-console-args must be set properly. +To use this function, ein:console-security-dir and +ein:console-args must be set properly. This function requires Fabian Gallina’s python.el for now; It should be possible to support python-mode.el. Patches are welcome!

    @@ -612,7 +628,7 @@ given, open the last point in the other window.

    -M-RET ein:notebook-execute-current-cell-and-goto-next
    +M-RET ein:worksheet-execute-cell-and-goto-next

    Execute cell at point if it is a code cell and move to the next cell, or insert if none.

    @@ -642,27 +658,36 @@ given, open the last point in the other window.

    -<C-up> ein:notebook-goto-prev-input-command
    +<M-S-return> ein:worksheet-execute-cell-and-insert-below + +

    Execute cell at point if it is a code cell and insert a +cell bellow.

    +
    -<C-down> ein:notebook-goto-next-input-command
    +<C-up> ein:worksheet-goto-prev-input
    -<M-up> ein:notebook-move-cell-up-command
    +<C-down> ein:worksheet-goto-next-input
    -<M-down> ein:notebook-move-cell-down-command
    +<M-up> ein:worksheet-move-cell-up
    -C-: ein:notebook-eval-string
    +<M-down> ein:worksheet-move-cell-down +
    + +
    +
    +C-: ein:shared-output-eval-string

    Evaluate a code. Prompt will appear asking the code to run. This is handy when you want to execute something quickly without @@ -690,15 +715,15 @@ shared output buffer. You can open the buffer by the command

    -
    -function ein:notebook-delete-cell-command
    +
    +function (ein:worksheet-delete-cell ws cell &optional focus)

    Delete a cell. (WARNING: no undo!) This command has no key binding because there is no way to undo deletion. Use kill to play on the safe side.

    If you really want use this command, you can do something like this (but be careful when using it!):

    (define-key ein:notebook-mode-map "\C-c\C-d"
-            'ein:notebook-delete-cell-command)
    + 'ein:worksheet-delete-cell)
    @@ -725,7 +750,7 @@ change in its input area.

    -

    Connected buffer

    +

    Connected buffer

    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, @@ -744,6 +769,14 @@ See also: +

    +C-c C-l ein:connect-reload-buffer
    + +

    Reload buffer using the command set by ein:connect-reload-command.

    +
    + +
    C-c C-r ein:connect-eval-region
    @@ -751,12 +784,17 @@ See also:
    -C-c C-f ein:connect-request-tool-tip-or-help-command
    +C-c C-f ein:pytools-request-tooltip-or-help + +

    Show the help for the object at point using tooltip. +When the prefix argument C-u is given, open the help in the +pager buffer. You can explicitly specify the object by selecting it.

    +
    -C-c TAB ein:connect-complete-command
    +C-c TAB ein:completer-complete
    @@ -769,13 +807,49 @@ See also: C-c C-a ein:connect-toggle-autoexec

    Toggle auto-execution mode of the current connected buffer.

    +

    When auto-execution mode is on, cells in connected notebook will +be automatically executed whenever run, eval or reload command [4] +is called in this buffer.

    + + + + + +
    [4]

    Namely, one of

    + +

    Note that you need to set cells to run in the connecting buffer or no cell will be executed. -Use the ein:notebook-turn-on-autoexec command in notebook to +Use the ein:worksheet-turn-on-autoexec command in notebook to change the cells to run.

    +
    +
    +C-c C-o ein:console-open
    + +

    Open IPython console. +To use this function, ein:console-security-dir and +ein:console-args must be set properly. +This function requires Fabian Gallina’s python.el for now; +It should be possible to support python-mode.el. Patches are welcome!

    +
    +
    + +
    +
    +C-c C-x ein:tb-show
    + +

    Popup traceback viewer.

    +
    +
    +
    C-c C-. ein:pytools-jump-to-source-command
    @@ -799,7 +873,14 @@ given, open the last point in the other window.

    -C-: ein:connect-eval-string
    +C-: ein:shared-output-eval-string + +

    Evaluate a code. Prompt will appear asking the code to run. +This is handy when you want to execute something quickly without +making a cell. If the code outputs something, it will go to the +shared output buffer. You can open the buffer by the command +ein:shared-output-pop-to-buffer.

    +
    @@ -849,7 +930,7 @@ Variable -

    Shared output buffer

    +

    Shared output buffer

    function ein:shared-output-pop-to-buffer
    @@ -859,12 +940,9 @@ Variable ein:shared-output-mode.

    -M-. ein:pytools-jump-to-source-command
    +C-c C-x ein:tb-show -

    Jump to the source code of the object at point. -When the prefix argument C-u is given, open the source code -in the other window. You can explicitly specify the object by -selecting it.

    +

    Popup traceback viewer.

    @@ -879,6 +957,17 @@ selecting it.

    +
    +
    +M-. ein:pytools-jump-to-source-command
    + +

    Jump to the source code of the object at point. +When the prefix argument C-u is given, open the source code +in the other window. You can explicitly specify the object by +selecting it.

    +
    +
    +
    q bury-buffer
    @@ -886,7 +975,7 @@ selecting it.

    -

    Traceback viewer

    +

    Traceback viewer

    Traceback in notebook buffer is not easy to understand. You can open Traceback viewer by the command ein:notebook-view-traceback. In the Traceback viewer, following keybinds are available.

    @@ -913,7 +1002,7 @@ In the Traceback viewer, following keybinds are available.

    -

    PyTools

    +

    PyTools

    These commands can be used in the notebook buffer and the connected buffer.

    @@ -947,7 +1036,7 @@ to install it if you are using newer Emacs.

    -

    Misc

    +

    Misc

    function helm-ein-notebook-buffers
    @@ -963,12 +1052,12 @@ to install it if you are using newer Emacs.

    -

    Customization

    +

    Customization

    You can customize EIN using the Emacs customization UI by typing M-x customize-group RET ein RET. All the configurable variables are listed below.

    -

    Subpackages

    +

    Subpackages

    variable ein:use-auto-complete
    @@ -1012,8 +1101,8 @@ commands is fine.

    -
    -

    Notebook list

    +
    +

    Notebook list

    variable ein:url-or-port
    @@ -1031,8 +1120,8 @@ Notebook server.

    -
    -

    Notebook

    +
    +

    Notebook

    variable ein:notebook-enable-undo
    @@ -1116,43 +1205,6 @@ notebook. For global setting and more information, see ein:query-timeout.

    -
    -
    -variable ein:notebook-console-security-dir
    -

    Security directory setting.

    -

    Following types are valid:

    -
    -
    string
    -
    Use this value as a path to security directory. -Handy when you have only one IPython server.
    -
    alist
    -
    An alist whose element is “(URL-OR-PORT . DIR)”. -Key (URL-OR-PORT) can be string (URL), integer (port), or -default (symbol). The value of default is used when -other key does not much. Normally you should have this -entry.
    -
    function
    -
    Called with an argument URL-OR-PORT (integer or string). -You can have complex setting using this.
    -
    -
    - -
    -
    -variable ein:notebook-console-executable
    -

    IPython executable used for console.

    -

    Example: "/user/bin/ipython". -Types same as ein:notebook-console-security-dir are valid.

    -
    - -
    -
    -variable ein:notebook-console-args
    -

    Additional argument when using console.

    -

    Example: "--ssh HOSTNAME". -Types same as ein:notebook-console-security-dir are valid.

    -
    -
    variable ein:cell-traceback-level
    @@ -1192,14 +1244,61 @@ must be t
    +
    +
    +

    Console

    +
    +
    +variable ein:console-security-dir
    +

    Security directory setting.

    +

    Following types are valid:

    +
    +
    string
    +
    Use this value as a path to security directory. +Handy when you have only one IPython server.
    +
    alist
    +
    An alist whose element is “(URL-OR-PORT . DIR)”. +Key (URL-OR-PORT) can be string (URL), integer (port), or +default (symbol). The value of default is used when +other key does not much. Normally you should have this +entry.
    +
    function
    +
    Called with an argument URL-OR-PORT (integer or string). +You can have complex setting using this.
    +
    +
    + +
    +
    +variable ein:console-executable
    +

    IPython executable used for console.

    +

    Example: "/user/bin/ipython". +Types same as ein:console-security-dir are valid.

    +
    + +
    +
    +variable ein:console-args
    +

    Additional argument when using console.

    +

    Example: "--ssh HOSTNAME". +Types same as ein:console-security-dir are valid.

    +
    +
    -

    Connect

    +

    Connect

    variable ein:connect-run-command

    %run magic command used for ein:connect-run-buffer. -Types same as ein:notebook-console-security-dir are valid.

    +Types same as ein:console-security-dir are valid.

    +
    + +
    +
    +variable ein:connect-reload-command
    +

    Setting for ein:connect-reload-buffer. +Same as ein:connect-run-command.

    @@ -1223,8 +1322,8 @@ as -

    MuMaMo

    +
    +

    MuMaMo

    variable ein:mumamo-codecell-mode
    @@ -1283,8 +1382,8 @@ problem.

    -
    -

    Misc

    +
    +

    Misc

    variable ein:filename-translations
    @@ -1359,14 +1458,14 @@ let me know or send pull request at github!
    -

    Gotchas and caveats

    +

    Gotchas and caveats

    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’m not sure – it’s possible that I am misusing the libraries!).

    If you know how to fix/workaround them, patches are very welcome.

    -

    url-retrieve

    +

    url-retrieve

    While using EIN, probably most of the error messages are about server connections. It looks like the problem is in url-retrieve. But in those cases you don’t loose any notebook data and your IPython @@ -1375,23 +1474,23 @@ fine most of the time. For saving notebook, I implemented code to retry when there is an error comes from url-retrieve to make it even safer.

    -
    -

    MuMaMo

    +
    +

    MuMaMo

    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 [4].

    +the input area. It seems there is a bug in MuMaMo [5].

    If you are using smartrep and MuMaMo together, see also the warning in ein:use-smartrep document.

    -
    [4]See the relevant bug report I posted: +
    [5]See the relevant bug report I posted: https://bugs.launchpad.net/nxhtml/+bug/1013794
    -

    python-mode.el

    +

    python-mode.el

    In my environment, using python-mode.el without byte-compiling it in MuMaMo based notebook mode produces segfault.

    Also, mumamo-idle-set-major-mode messages error @@ -1400,7 +1499,7 @@ time to time, making minibuffer bit noisy while editing notebook.

    -

    Advanced

    +

    Advanced

    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 emacslisp.py for more details.

    @@ -1415,9 +1514,9 @@ web client. See -

    Reporting issue

    +

    Reporting issue

    -

    Logging

    +

    Logging

    Sometime more information that the *Message* buffer provides is needed to debug.

      @@ -1441,8 +1540,8 @@ a code block, like this:

      gist.

    -
    -

    websocket.el

    +
    +

    websocket.el

    websocket.el has its logging buffer. Sometime its useful to see its log. This is how to do that.

      @@ -1457,7 +1556,7 @@ These command must be called in the notebook buffer.
    -

    Debugging

    +

    Debugging

    If you are interested in debugging EIN, you should start it with calling the command ein:dev-start-debug. This command sets debug-on-error to t and do some @@ -1469,9 +1568,32 @@ with ein:dev-st

    -

    Change Log

    +

    Change Log

    +
    +

    v0.2

    +
      +
    • Add 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 ein:connect-toggle-autoexec.
      • +
    • [WIP] Worksheet support.
      • +
    +
    +
    +

    v0.1.2

    +
      +
    • Mostly refactoring for worksheet support in v0.2.
      • +
    • Rename command ein:notebook-console-open to +ein:console-open. It is available from non-notebook +buffer such as connected buffer now.
      • +
    • Add ein:connect-reload-buffer. +Old default ein:connect-run-buffer behavior is +replaced by this function. ein:connect-run-buffer +now actually runs buffer instead of loading it.
      • +
    +
    -

    v0.1.1

    +

    v0.1.1

    -

    License

    +

    License

    Emacs IPython Notebook is licensed under GPL v3. See COPYING for details.

    diff --git a/objects.inv b/objects.inv index 00ee71e..e5bd41e 100644 --- a/objects.inv +++ b/objects.inv @@ -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 0E9ŀnSp \('H!)&ކF4P? - Search — Emacs IPython Notebook 0.1.2alpha0 documentation + Search — Emacs IPython Notebook 0.2.0alpha0 documentation @@ -15,7 +15,7 @@ - + @@ -39,7 +39,7 @@
  • index
    • -
  • Emacs IPython Notebook 0.1.2alpha0 documentation »
    • +
  • Emacs IPython Notebook 0.2.0alpha0 documentation »
    • @@ -81,7 +81,7 @@
  • index
    • -
  • Emacs IPython Notebook 0.1.2alpha0 documentation »
    • +
  • Emacs IPython Notebook 0.2.0alpha0 documentation »
    • diff --git a/searchindex.js b/searchindex.js index 5a53f4e..9723b59 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:0,code:0,forget:0,scratch:0,global:0,prefix:0,higher:0,follow:0,keybind:0,millisecond:0,whose:0,graph:0,debbug:0,send:0,iexec:0,program:0,opposit:0,sourc:0,everi:0,string:0,util:0,upstream:0,veri:0,relev:0,magic:0,level:0,lisp:0,button:0,list:0,"try":0,item:0,quick:0,prepar:0,dir:0,pleas:0,prevent:0,markdowncel:0,jump:0,second:0,pass:0,download:0,port:0,append:0,even:0,index:0,what:0,hide:0,appear:0,section:0,current:0,delet:0,version:0,"new":0,net:0,widget:0,full:0,chose:0,buri:0,gener:0,here:0,pytool:0,ewoc:0,slow:0,modif:0,debugg:0,path:0,safer:0,sinc:0,valu:0,convert:0,produc:0,keymap:0,doctest:0,chang:0,via:0,repositori:0,prefer:0,textcel:0,ask:0,api:0,visibl:0,instal:0,redo:0,select:0,from:0,regist:0,two:0,next:0,websit:0,call:0,prev:0,type:0,tell:0,toggl:0,more:0,relat:0,notic:0,warn:0,flag:0,indic:0,actual:0,cach:0,must:0,none:0,retriev:0,setup:0,work:0,dev:0,can:0,caveat:0,under:0,omit:0,prompt:0,want:0,give:0,process:0,share:0,templat:0,tab:0,onlin:0,risk:0,delai:0,alwai:0,end:0,newlin:0,turn:0,spreadsheet:0,snippet:0,how:0,instead:0,simpl:0,collaps:0,map:0,mess:0,max:0,clone:0,after:0,usabl:0,reflect:0,befor:0,wrong:0,notebook:0,goodi:0,mai:0,data:0,delq:0,github:0,ani:0,bind:0,secur:0,melpa:0,element:0,caus:0,inform:0,repl:0,environ:0,allow:0,enter:0,fallback:0,first:0,order:0,origin:0,help:0,ouput:0,over:0,move:0,becaus:0,report:0,iopub:0,keyboard:0,hierarchi:0,hook:0,group:0,fix:0,better:0,segfault:0,window:0,html:0,restart:0,hidden:0,main:0,alter:0,non:0,"return":0,thei:0,python:0,auto:0,safe:0,alist:0,handi:0,interrupt:0,now:0,complain:0,introduct:0,name:0,anyth:0,edit:0,hierarchymag:0,cell:0,separ:0,easili:0,fabian:0,mode:0,timeout:0,each:0,debug:0,fulli:0,updat:0,side:0,truncat:0,nxhtml:0,compil:0,continu:0,realli:0,heavi:0,connect:0,out:0,variabl:0,shown:0,screenshot:0,reload:0,ret:0,content:0,nbpath:0,"5e4f74d1":0,adapt:0,print:0,notebooklist:0,"goto":0,insid:0,advanc:0,manipul:0,given:0,undo:0,standard:0,ajax:0,base:0,put:0,org:0,"byte":0,care:0,indent:0,launch:0,traceback:0,gallina:0,thing:0,outsid:0,think:0,lambda:0,oper:0,info:0,major:0,directli:0,onc:0,misc:0,number:0,reopen:0,alreadi:0,ring:0,open:0,gpl:0,avail:0,differ:0,workaround:0,licens:0,sometim:0,messag:0,too:0,store:0,includ:0,shell:0,consol:0,option:0,especi:0,fuzzi:0,gotcha:0,copi:0,listp:0,specifi:0,part:0,enclos:0,mostli:0,rst:0,reinstal:0,past:0,kind:0,provid:0,remov:0,emac:0,entri:0,posit:0,zeroein:0,browser:0,websocket:0,viewer:0,anywher:0,raw:0,have:0,tabl:0,need:0,seem:0,packag:0,issu:0,equival:0,callback:0,panda:0,note:0,also:0,exampl:0,take:0,autoexec:0,tool:0,sure:0,distribut:0,normal:0,buffer:0,previou:0,most:0,plai:0,preset:0,pair:0,pager:0,"class":0,latex:0,don:0,url:0,clear:0,request:0,doe:0,tracker:0,determin:0,occasion:0,usual:0,dot:0,yank:0,tkf:0,show:0,text:0,random:0,syntax:0,fine:0,access:0,onli:0,explicitli:0,launchpad:0,configur:0,releas:0,should:0,offici:0,headingcel:0,hit:0,get:0,stop:0,cannot:0,ssh:0,lighter:0,increas:0,requir:0,enabl:0,patch:0,twice:0,integr:0,contain:0,where:0,view:0,kernel:0,set:0,helm:0,see:0,num:0,result:0,arg:0,fail:0,close:0,deriv:0,infinit:0,someth:0,misus:0,favor:0,between:0,"import":0,mumamo:0,popup:0,kei:0,javascript:0,extens:0,otherwis:0,ipython:0,decreas:0,come:0,addit:0,last:0,expos:0,region:0,equal:0,etc:0,instanc:0,"9646adea5172":0,let:0,com:0,load:0,markdown:0,simpli:0,point:0,pop:0,solv:0,cancel:0,typic:0,assum:0,creat:0,tramp:0,three:0,empti:0,json:0,much:0,cbarg:0,interest:0,immedi:0,quickli:0,gist:0,imag:0,search:0,argument:0,understand:0,togeth:0,instant:0,those:0,"case":0,backtab:0,look:0,gnu:0,plain:0,servic:0,batch:0,defin:0,"while":0,abov:0,error:0,exist:0,loos:0,loop:0,ein:0,propag:0,helper:0,omni:0,readi:0,"__main__":0,them:0,develop:0,welcom:0,minim:0,make:0,same:0,handl:0,complex:0,split:0,document:0,complet:0,development:0,finish:0,http:0,hostnam:0,nil:0,again:0,effect:0,remot:0,user:0,improv:0,stack:0,subpackag:0,off:0,macro:0,inherit:0,without:0,client:0,command:0,setq:0,thi:0,choos:0,aotoexec:0,everyth:0,latest:0,protocol:0,just:0,object:0,tip:0,slime:0,rest:0,kill:0,heavili:0,flavor:0,querti:0,yet:0,web:0,cut:0,easi:0,littl:0,add:0,other:0,input:0,save:0,minibuff:0,useless:0,bin:0,applic:0,which:0,format:0,read:0,emacslisp:0,know:0,backquot:0,bit:0,superpack:0,insert:0,like:0,specif:0,filenam:0,safest:0,manual:0,integ:0,server:0,either:0,output:0,smartrep:0,page:0,old:0,some:0,back:0,hacki:0,guess:0,librari:0,freez:0,implement:0,avoid:0,definit:0,tooltip:0,whole:0,usernam:0,retri:0,larg:0,deficit:0,localhost:0,cgi:0,who:0,run:0,power:0,inspect:0,usag:0,noisi:0,host:0,although:0,"__name__":0,post:0,about:0,rawcel:0,unsav:0,idl:0,codecel:0,act:0,discard:0,mean:0,disabl:0,block:0,own:0,automat:0,down:0,your:0,merg:0,git:0,log:0,wai:0,area:0,execut:0,support:0,"long":0,custom:0,verbos:0,start:0,reli:0,interfac:0,"4e7e":0,lot:0,forward:0,"function":0,head:0,properli:0,reorgan:0,form:0,link:0,translat:0,newer:0,renam:0,line:0,inlin:0,bug:0,reset:0,pull:0,possibl:0,whether:0,maximum:0,below:0,minor:0,highlight:0,problem:0,similar:0,htmlcell:0,featur:0,evalu:0,eieio:0,bugreport:0,file:0,face:0,check:0,probabl:0,imenu:0,ce91:0,when:0,detail:0,"default":0,valid:0,test:0,you:0,draw:0,clean:0,symbol:0,queri:0,eval:0,singleton:0,directori:0,space:0,carriag:0,datafram:0,time:0,backward: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,forget:0,scratch:0,global:0,prefix:0,higher:0,follow:0,keybind:0,millisecond:0,whose:0,graph:0,debbug:0,send:0,iexec:0,program:0,queri:0,sourc:0,everi:0,string:0,util:0,upstream:0,veri:0,relev:0,magic:0,level:0,lisp:0,button:0,list:0,"try":0,item:0,quick:0,prepar:0,dir:0,pleas:0,prevent:0,markdowncel:0,jump:0,second:0,pass:0,download:0,port:0,append:0,even:0,index:0,what:0,hide:0,appear:0,section:0,current:0,delet:0,version:0,"new":0,net:0,widget:0,full:0,chose:0,buri:0,gener:0,here:0,pytool:0,ewoc:0,slow:0,modif:0,debugg:0,path:0,safer:0,sinc:0,valu:0,convert:0,produc:0,keymap:0,doctest:0,chang:0,via:0,repositori:0,prefer:0,textcel:0,ask:0,api:0,visibl:0,instal:0,redo:0,select:0,highli:0,from:0,regist:0,two:0,next:0,websit:0,call:0,recommend:0,prev:0,type:0,tell:0,toggl:0,more:0,relat:0,notic:0,warn:0,flag:0,indic:0,actual:0,given:0,cach:0,must:0,none:0,retriev:0,setup:0,work:0,focu:0,dev:0,can:0,caveat:0,under:0,omit:0,prompt:0,want:0,give:0,process:0,share:0,templat:0,tab:0,onlin:0,risk:0,delai:0,alwai:0,end:0,newlin:0,turn:0,spreadsheet:0,snippet:0,how:0,instead:0,simpl:0,collaps:0,map:0,mess:0,max:0,clone:0,after:0,usabl:0,reflect:0,befor:0,wrong:0,notebook:0,goodi:0,mai:0,data:0,delq:0,github:0,ani:0,bind:0,secur:0,melpa:0,element:0,caus:0,inform:0,repl:0,environ:0,allow:0,enter:0,fallback:0,first:0,order:0,origin:0,help:0,over:0,move:0,becaus:0,report:0,iopub:0,keyboard:0,hierarchi:0,hook:0,group:0,fix:0,better:0,segfault:0,window:0,html:0,restart:0,hidden:0,main:0,alter:0,non:0,"return":0,thei:0,python:0,auto:0,safe:0,alist:0,handi:0,interrupt:0,now:0,complain:0,introduct:0,name:0,anyth:0,edit:0,hierarchymag:0,cell:0,separ:0,easili:0,fabian:0,mode:0,timeout:0,each:0,debug:0,updat:0,side:0,truncat:0,nxhtml:0,compil:0,replac:0,continu:0,realli:0,heavi:0,connect:0,out:0,variabl:0,shown:0,screenshot:0,reload:0,ret:0,content:0,nbpath:0,"5e4f74d1":0,adapt:0,print:0,notebooklist:0,"goto":0,insid:0,advanc:0,manipul:0,guess:0,undo:0,standard:0,ajax:0,base:0,put:0,org:0,"byte":0,care:0,indent:0,launch:0,traceback:0,gallina:0,thing:0,outsid:0,think:0,lambda:0,oper:0,info:0,major:0,directli:0,onc:0,misc:0,number:0,reopen:0,alreadi:0,ring:0,open:0,gpl:0,avail:0,differ:0,workaround:0,licens:0,sometim:0,messag:0,too:0,store:0,includ:0,shell:0,consol:0,option:0,especi:0,fuzzi:0,gotcha:0,copi:0,listp:0,specifi:0,part:0,enclos:0,mostli:0,rst:0,reinstal:0,past:0,kind:0,whenev:0,provid:0,remov:0,emac:0,entri:0,posit:0,zeroein:0,browser:0,websocket:0,abov:0,viewer:0,anywher:0,raw:0,have:0,tabl:0,need:0,seem:0,packag:0,issu:0,equival:0,callback:0,panda:0,note:0,also:0,exampl:0,take:0,autoexec:0,sure:0,distribut:0,normal:0,buffer:0,previou:0,most:0,plai:0,preset:0,pair:0,pager:0,"class":0,latex:0,don:0,url:0,clear:0,request:0,doe:0,tracker:0,determin:0,occasion:0,usual:0,dot:0,yank:0,tkf:0,show:0,opposit:0,random:0,syntax:0,fine:0,access:0,onli:0,explicitli:0,launchpad:0,configur:0,releas:0,should:0,offici:0,headingcel:0,hit:0,get:0,stop:0,cannot:0,ssh:0,lighter:0,increas:0,requir:0,enabl:0,patch:0,twice:0,integr:0,contain:0,where:0,view:0,wiki:0,kernel:0,set:0,helm:0,see:0,num:0,result:0,arg:0,fail:0,close:0,deriv:0,infinit:0,someth:0,misus:0,favor:0,between:0,"import":0,mumamo:0,popup:0,kei:0,javascript:0,extens:0,otherwis:0,ipython:0,decreas:0,come:0,addit:0,last:0,expos:0,region:0,equal:0,etc:0,instanc:0,"9646adea5172":0,let:0,com:0,load:0,markdown:0,simpli:0,point:0,pop:0,solv:0,cancel:0,typic:0,assum:0,creat:0,tramp:0,three:0,empti:0,json:0,much:0,cbarg:0,interest:0,immedi:0,quickli:0,gist:0,imag:0,search:0,argument:0,understand:0,togeth:0,instant:0,those:0,"case":0,backtab:0,look:0,gnu:0,plain:0,servic:0,batch:0,defin:0,"while":0,behavior:0,error:0,exist:0,loos:0,loop:0,ein:0,propag:0,helper:0,omni:0,readi:0,"__main__":0,them:0,develop:0,welcom:0,minim:0,make:0,same:0,handl:0,complex:0,split:0,document:0,complet:0,development:0,finish:0,http:0,hostnam:0,nil:0,again:0,effect:0,remot:0,user:0,mani:0,stack:0,subpackag:0,off:0,macro:0,inherit:0,without:0,client:0,command:0,setq:0,thi:0,choos:0,aotoexec:0,everyth:0,latest:0,bellow:0,protocol:0,just:0,object:0,tip:0,slime:0,rest:0,kill:0,heavili:0,flavor:0,querti:0,yet:0,web:0,cut:0,easi:0,littl:0,add:0,other:0,input:0,save:0,minibuff:0,useless:0,bin:0,applic:0,which:0,format:0,read:0,emacslisp:0,know:0,backquot:0,bit:0,superpack:0,insert:0,like:0,specif:0,filenam:0,safest:0,manual:0,integ:0,server:0,either:0,output:0,smartrep:0,page:0,old:0,wip:0,some:0,back:0,hacki:0,librari:0,freez:0,implement:0,avoid:0,definit:0,tooltip:0,whole:0,usernam:0,retri:0,larg:0,deficit:0,localhost:0,cgi:0,who:0,run:0,power:0,inspect:0,usag:0,noisi:0,host:0,although:0,"__name__":0,post:0,about:0,rawcel:0,face:0,worksheet:0,unsav:0,idl:0,codecel:0,act:0,discard:0,mean:0,disabl:0,block:0,own:0,automat:0,down:0,pivot:0,your:0,merg:0,git:0,log:0,wai:0,area:0,execut:0,support:0,"long":0,custom:0,verbos:0,start:0,reli:0,trigger:0,interfac:0,"4e7e":0,lot:0,forward:0,"function":0,head:0,properli:0,reorgan:0,form:0,link:0,translat:0,newer:0,renam:0,line:0,inlin:0,bug:0,reset:0,pull:0,possibl:0,whether:0,maximum:0,below:0,minor:0,highlight:0,problem:0,similar:0,htmlcell:0,featur:0,evalu:0,eieio:0,bugreport:0,file:0,improv:0,check:0,probabl:0,imenu:0,ce91:0,when:0,detail:0,refactor:0,"default":0,valid:0,test:0,you:0,draw:0,clean:0,symbol:0,eval:0,singleton:0,outdat:0,directori:0,space:0,carriag:0,text:0,datafram:0,time:0,backward:0},objtypes:{},titles:["Welcome to Emacs IPython Notebook’s documentation!"],objnames:{},filenames:["index"]}) \ No newline at end of file