diff --git a/_sources/index.txt b/_sources/index.txt index b5069c2..8adf43e 100644 --- a/_sources/index.txt +++ b/_sources/index.txt @@ -16,14 +16,13 @@ accessed anywhere in Emacs and improve Python code editing and reading in Emacs. Highlighted features: -* Copy/paste cells, even to/from different notebooks. -* Console integration: You can easily connect to kernel via console - application. This enables you to start debugging in the same - kernel. It is even possible to connect console over ssh [#]_. -* IPython kernel can be "connected" to any buffers. This enables you - to evaluate buffer/region using same kernel as notebook. Notebook - goodies such as tooltip help, help browser and code completion are - available in these buffers. [#]_ +* Copy/paste cells in and between notebooks. +* Console integration: You can easily connect to a kernel via a console + application. This enables you to start debugging in the same kernel. It is + even possible to connect a console over ssh [#]_. +* IPython kernel can be "connected" to a buffer. This enables you to evaluate + buffer/region using same kernel as notebook. Notebook goodies such as tooltip + help, help browser and code completion are available in these buffers. [#]_ * Jump to definition (go to the definition by hitting ``M-.`` over an object). @@ -65,11 +64,10 @@ Links: Quick try --------- -This is a quick and clean way to try EIN separately from your Emacs -setting. If you want to try EIN but think preparing all the -requirements is too much, try this!:: +If you want to try EIN but think preparing all the requirements is too much, try +this!:: - git clone git://github.com/tkf/emacs-ipython-notebook.git + git clone git://github.com/millejoh/emacs-ipython-notebook.git cd emacs-ipython-notebook/ lisp/zeroein.el @@ -218,9 +216,9 @@ Usage 2. Hit ``M-x ein:notebooklist-open`` to open notebook list. This will open :ref:`notebook list ` buffer. -3. In the notebook list buffer, you can open notebooks by hitting - ``[Open]`` buttons. See :ref:`notebook ` - section for what you can do in the notebook buffer. +3. In the notebook list buffer, you can open notebooks by selecting the + ``[Open]`` buttons. See the :ref:`notebook ` section for + operations and commands available in the notebook buffer. .. _`IPython notebook server`: http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html @@ -266,12 +264,11 @@ The following keybinds are available in notebook buffers. 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, -etc. Once the buffer is connected to the notebook, minor mode -:el:symbol:`ein:connect-mode` is enabled and the following keybinds -are available. +You can connect any buffer (though typically a buffer that contains a Python +file) to an opened notebook and use the kernel of that notebook to execute code, +inspect objects, auto-complete code, jump to the other source, etc. Once the +buffer is connected to the notebook, minor mode :el:symbol:`ein:connect-mode` is +enabled and the following keybinds are available. .. el:keymap:: ein:connect-mode-map :replace: s/C-c TAB/C-c C-i/ @@ -292,8 +289,9 @@ Shared output buffer Traceback viewer ^^^^^^^^^^^^^^^^ -Traceback in notebook buffer is not easy to understand. You can open -Traceback viewer by the command :el:symbol:`ein:notebook-view-traceback`. +Tracebacks from the notebook buffer can be difficult to understand. You can +open a Traceback viewer by calling :el:symbol:`ein:notebook-view-traceback`. + In the Traceback viewer, following keybinds are available. .. el:keymap:: ein:traceback-mode-map @@ -308,6 +306,7 @@ buffer. .. el:function:: ein:pytools-whos .. el:function:: ein:pytools-hierarchy .. el:function:: ein:pytools-pandas-to-ses +.. el:function:: ein:pytools-export-buffer Misc ^^^^ @@ -348,9 +347,8 @@ You can link to IPython notebook from org-mode_ files. 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. +You can customize EIN by typing ``M-x customize-group RET ein RET``. All the +configurable variables are listed below. Subpackages ^^^^^^^^^^^ @@ -445,7 +443,7 @@ If you know how to fix/workaround them, patches are very welcome. While using EIN, probably most of the error messages are about server connections. It looks like the problem is in :el:symbol:`url-retrieve`. -But in those cases you don't loose any notebook data and your IPython +But in those cases you don't lose any notebook data and your IPython kernel is fine. You can just type the command again and it will go fine most of the time. For saving notebook, I implemented code to retry when there is an error comes from :el:symbol:`url-retrieve` to @@ -538,8 +536,8 @@ needed to debug. websocket.el """""""""""" -websocket.el has its logging buffer. Sometime its useful to see its -log. This is how to do that. +websocket.el has its own logging buffer. Sometime it is useful to see this +log. To do this: 1. ``(require 'ein-dev)`` 2. ``(setq websocket-debug t)`` or call :el:symbol:`ein:dev-start-debug`. @@ -552,21 +550,40 @@ log. This is how to do that. Debugging ^^^^^^^^^ -If you are interested in debugging EIN, you should start it with -calling the command :el:symbol:`ein:dev-start-debug`. -If the bug is websocket related, you may need to run it with a -prefix key like this: ``C-u M-x ein:dev-start-debug RET`` to get -a backtrace. -This command sets :el:symbol:`debug-on-error` to ``t`` and do some -patching to debugger. This patching is required because printing EWOC -objects freezes Emacs otherwise. It also changes log level to -log everything the log buffer. You can reset the patch and log level -with :el:symbol:`ein:dev-stop-debug`. +If you are interested in debugging EIN, you should start by calling the command +:el:symbol:`ein:dev-start-debug`. If the bug is websocket related, you may need +to run it with a prefix key like this: ``C-u M-x ein:dev-start-debug RET`` to +get a backtrace. This command sets :el:symbol:`debug-on-error` to ``t`` and +does some patching to the debugger. This patching is required because printing +EWOC objects freezes Emacs otherwise. It also changes log level to report +everything the log buffer. You can reset the patch and log level with +:el:symbol:`ein:dev-stop-debug`. Change Log ========== +v0.4 +---- + +* Finalizing support for IPython 3.0. +* Better support for globally opening notebooks stored in a directory hierarchy. +* Partial refactoring of the interace to IPython's content/notebook REST interface into + ein-contents-api.el. +* ein-mumamo.el has been moved into its own package, ein-mumamo. This should get rid + of compilation errors for anyone who does not happen to have nxhtml installed. +* Restore support for heading level cells with nbformat v4 notebooks. +* New (buggy) pytools function `ein:pytools-export-buffer` for using nbconvert on a notebook + buffer. + +v0.3 +---- + +* New maintainer - John Miller (millejoh at mac dot com) +* Official repository is now at https://github.com/millejoh/emacs-ipython-notebook +* Support for IPython 2.x and 3.x added. +* Support for IPython 1.x and earlier removed. + v0.2.1 ------ diff --git a/_static/pygments.css b/_static/pygments.css index d79caa1..57eadc0 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -40,6 +40,7 @@ .highlight .nv { color: #bb60d5 } /* Name.Variable */ .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #208050 } /* Literal.Number.Bin */ .highlight .mf { color: #208050 } /* Literal.Number.Float */ .highlight .mh { color: #208050 } /* Literal.Number.Hex */ .highlight .mi { color: #208050 } /* Literal.Number.Integer */ diff --git a/genindex.html b/genindex.html index 339f8bd..4651542 100644 --- a/genindex.html +++ b/genindex.html @@ -7,7 +7,7 @@ - Index — Emacs IPython Notebook 0.3.0 documentation + Index — Emacs IPython Notebook 0.4.0 documentation @@ -15,7 +15,7 @@ - + @@ -264,6 +264,10 @@ +
ein:pytools-export-buffer (Lisp function) +
+ +
ein:pytools-hierarchy (Lisp function)
@@ -354,7 +358,7 @@
  • index
  • -
  • Emacs IPython Notebook 0.3.0 documentation »
  • +
  • Emacs IPython Notebook 0.4.0 documentation »
  • Quick try

    -

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

    -
    git clone git://github.com/tkf/emacs-ipython-notebook.git
    +

    If you want to try EIN but think preparing all the requirements is too much, try +this!:

    +
    git clone git://github.com/millejoh/emacs-ipython-notebook.git
     cd emacs-ipython-notebook/
     lisp/zeroein.el
     
    @@ -299,9 +299,9 @@ don’t use that optional package.

  • Start IPython notebook server.
  • Hit M-x ein:notebooklist-open to open notebook list. This will open notebook list buffer.
  • -
  • In the notebook list buffer, you can open notebooks by hitting -[Open] buttons. See notebook -section for what you can do in the notebook buffer.
  • +
  • In the notebook list buffer, you can open notebooks by selecting the +[Open] buttons. See the notebook section for +operations and commands available in the notebook buffer.
  • @@ -997,12 +997,11 @@ change in its input area.

    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, -etc. Once the buffer is connected to the notebook, minor mode -ein:connect-mode is enabled and the following keybinds -are available.

    +

    You can connect any buffer (though typically a buffer that contains a Python +file) to an opened notebook and use the kernel of that notebook to execute code, +inspect objects, auto-complete code, jump to the other source, etc. Once the +buffer is connected to the notebook, minor mode ein:connect-mode is +enabled and the following keybinds are available.

    C-c C-c ein:connect-run-or-eval-buffer
    @@ -1242,9 +1241,9 @@ selecting it.

    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.

    +

    Tracebacks from the notebook buffer can be difficult to understand. You can +open a Traceback viewer by calling ein:notebook-view-traceback.

    +

    In the Traceback viewer, following keybinds are available.

    Keymap for ein:traceback-mode.

    @@ -1300,6 +1299,25 @@ Open a ses-mode to install it if you are using newer Emacs.

    +
    +
    +function (ein:pytools-export-buffer buffer format)
    +

    Export contents of notebook using nbconvert to user-specified format +(options will depend on the version of nbconvert available) to a new buffer.

    +

    Currently EIN/IPython supports exporting to the following formats:

    +
    +
      +
    • HTML
    • +
    • JSON (this is basically the sames opening the ipynb file in a buffer).
    • +
    • Latex
    • +
    • Markdown
    • +
    • Python
    • +
    • RST
    • +
    • Slides
    • +
    +
    +
    +

    Misc

    @@ -1351,9 +1369,8 @@ the link at the point of cursor.

    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.

    +

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

    Subpackages

    @@ -1501,12 +1518,7 @@ This is the old default setting:

    variable ein:notebook-querty-timeout-open
    -

    Query timeout for opening notebook. -If you cannot open large notebook because of timeout error, try -to increase this value. Setting this value to nil means to use -global setting. For global setting and more information, see -ein:query-timeout.

    -
    +
    @@ -1776,59 +1788,42 @@ To use EIN and Jedi together, add the following in your Emacs setup.:

    variable ein:mumamo-codecell-mode
    -

    Major Mode for Code Cell.

    -
    +
    variable ein:mumamo-textcell-mode
    -

    Major Mode for Text Cell.

    -
    +
    variable ein:mumamo-htmlcell-mode
    -

    Major Mode for HTML Cell.

    -
    +
    variable ein:mumamo-markdowncell-mode
    -

    Major Mode for Markdown Cell.

    -
    +
    variable ein:mumamo-rawcell-mode
    -

    Major Mode for Raw Cell.

    -
    +
    variable ein:mumamo-headingcell-mode
    -

    Major Mode for Heading Cell.

    -
    +
    variable ein:mumamo-fallback-mode
    -

    Fallback Major Mode.

    -
    +
    variable ein:use-mumamo-indent-line-function-workaround
    -

    Turn on workaround for mumamo-indent-line-function.

    -

    In code cell, hitting TAB or C-j at the end of input area causes -error from MuMaMo. When this variable is non-nil, EIN patches -mumamo-indent-line-function to workaround this problem. This -workaround is on by default.

    -

    Note that python-mode’s indentation function has other problems -with MuMaMo. For example, hitting TAB twice, which decreases the -indentation level by one in normal Python buffer, causes similar -error in code cell. The current workaround does not fix this -problem.

    -
    +
    @@ -1921,7 +1916,7 @@ possible that I am misusing the libraries!).

    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 +But in those cases you don’t lose any notebook data and your IPython kernel is fine. You can just type the command again and it will go fine most of the time. For saving notebook, I implemented code to retry when there is an error comes from url-retrieve to @@ -2000,8 +1995,8 @@ a code block, like this:

    websocket.el

    -

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

    +

    websocket.el has its own logging buffer. Sometime it is useful to see this +log. To do this:

    1. (require 'ein-dev)
    2. (setq websocket-debug t) or call ein:dev-start-debug.
    3. @@ -2015,23 +2010,44 @@ These command must be called in the notebook buffer.

    Debugging

    -

    If you are interested in debugging EIN, you should start it with -calling the command ein:dev-start-debug. -If the bug is websocket related, you may need to run it with a -prefix key like this: C-u M-x ein:dev-start-debug RET to get -a backtrace. -This command sets debug-on-error to t and do some -patching to debugger. This patching is required because printing EWOC -objects freezes Emacs otherwise. It also changes log level to -log everything the log buffer. You can reset the patch and log level -with ein:dev-stop-debug.

    +

    If you are interested in debugging EIN, you should start by calling the command +ein:dev-start-debug. If the bug is websocket related, you may need +to run it with a prefix key like this: C-u M-x ein:dev-start-debug RET to +get a backtrace. This command sets debug-on-error to t and +does some patching to the debugger. This patching is required because printing +EWOC objects freezes Emacs otherwise. It also changes log level to report +everything the log buffer. You can reset the patch and log level with +ein:dev-stop-debug.

    Change Log

    +
    +

    v0.4

    +
      +
    • Finalizing support for IPython 3.0.
    • +
    • Better support for globally opening notebooks stored in a directory hierarchy.
    • +
    • Partial refactoring of the interace to IPython’s content/notebook REST interface into +ein-contents-api.el.
    • +
    • ein-mumamo.el has been moved into its own package, ein-mumamo. This should get rid +of compilation errors for anyone who does not happen to have nxhtml installed.
    • +
    • Restore support for heading level cells with nbformat v4 notebooks.
    • +
    • New (buggy) pytools function ein:pytools-export-buffer for using nbconvert on a notebook +buffer.
    • +
    +
    +
    +

    v0.3

    + +
    -

    v0.2.1

    +

    v0.2.1

    • Cached auto-complete is removed. ac-source-ein-cached and ac-complete-ein-cached @@ -2055,7 +2071,7 @@ This protocol is not used in EIN anywhere yet.
    -

    v0.2

    +

    v0.2

    • Preliminary login support. See ein:notebooklist-login.
    • Code completion in notebook happens really automatically. @@ -2110,7 +2126,7 @@ See ein:connect
    -

    v0.1.2

    +

    v0.1.2

    • Mostly refactoring for worksheet support in v0.2.
    • Rename command ein:notebook-console-open to @@ -2123,7 +2139,7 @@ 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.

    @@ -82,7 +82,7 @@
  • index
  • -
  • Emacs IPython Notebook 0.3.0 documentation »
  • +
  • Emacs IPython Notebook 0.4.0 documentation »