From 376100ba9cefb186fff6332d9f0aa81f01bf924e Mon Sep 17 00:00:00 2001 From: John Miller Date: Sat, 14 Apr 2018 16:41:10 -0500 Subject: [PATCH] v0.14.0 Update --- _sources/index.rst.txt | 38 +++++++++++-- _static/bizstyle.js | 2 +- genindex.html | 14 +++-- index.html | 120 +++++++++++++++++++++++++++++------------ objects.inv | Bin 402 -> 413 bytes search.html | 6 +-- searchindex.js | 2 +- 7 files changed, 136 insertions(+), 46 deletions(-) diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index 7fc46ab..706537f 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -406,9 +406,13 @@ argument. The format for the session argument is sys.version #+END_SRC -If your code block generates an image, like from an matplotlib plot, then -specify the file to save the image to using the `:image` argument as in the -example below: +By default EIN will execute asynchronously so you can continue to work in Emacs, but you may control this behavior via the :el:symbol:`ein-org-async-p`. + +If your code block generates an image, like from an matplotlib plot, ein will +automatically save to a file in the directory specified by +:el:symbol:`ein:org-inline-image-directory` and generate an appropriate inline +link. You can also specify the file to save the image to using by the `:image` +argument as in the example below: .. code:: python @@ -440,6 +444,32 @@ You can also link to an IPython notebook from org-mode_ files. .. [#org-store-link] See `1.3 Activation `_ in org-mode manual. +Customization +^^^^^^^^^^^^^ + +.. el:variable:: ein:org-async-p +.. el:variable:: ein:org-inline-image-directory + +Support for The Hy Language (EXPERIMENTAL) +------------------------------------------ + +New in v0.14, ein has limited support for executing hy_ code in a notebook +running an ipython kernel. Before trying this feature you will need to install hy +per the quickstart_ instructions. + +Once you have set up hy_ in your ipython kernel, open or create a notebook +running this kernel and create or go to an empty cell. You will need to change +the cell type to hy using :el:symbol:`ein:worksheet-change-cell-type`. Once that +is done you can enter hy expressions and they will be correctly evaluated by the +kernel! + +If you are running a `hy kernel`_ you can, of course, write hy expressions in +code cells and have the expected results. + +.. _hy: http://docs.hylang.org/en/stable/ +.. _quickstart: http://docs.hylang.org/en/stable/quickstart.html +.. _`hy kernel`: https://github.com/Calysto/calysto_hy + Customization ------------- @@ -663,6 +693,8 @@ everything the log buffer. You can reset the patch and log level with Change Log ========== +.. include:: Changelog/v0_14_0.txt + .. include:: Changelog/v0_13_1.txt .. include:: Changelog/v0_13_0.txt diff --git a/_static/bizstyle.js b/_static/bizstyle.js index 694301f..bb7af66 100644 --- a/_static/bizstyle.js +++ b/_static/bizstyle.js @@ -36,6 +36,6 @@ $(window).resize(function(){ $("li.nav-item-0 a").text("Top"); } else { - $("li.nav-item-0 a").text("Emacs IPython Notebook 0.13.1 documentation"); + $("li.nav-item-0 a").text("Emacs IPython Notebook 0.14.0 documentation"); } }); \ No newline at end of file diff --git a/genindex.html b/genindex.html index 8626ef1..123f7a1 100644 --- a/genindex.html +++ b/genindex.html @@ -7,7 +7,7 @@ - Index — Emacs IPython Notebook 0.13.1 documentation + Index — Emacs IPython Notebook 0.14.0 documentation @@ -28,7 +28,7 @@
  • index
    • -
  • Emacs IPython Notebook 0.13.1 documentation »
    • +
  • Emacs IPython Notebook 0.14.0 documentation »

    • Setup

    -

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

    +

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

    (require 'ein)
 (require 'ein-loaddefs)
 (require 'ein-notebook)
@@ -820,7 +825,7 @@ directly.
    
 
    Change the cell type of the current cell.
 Prompt will appear in the minibuffer.
    
 
    When used in as a Lisp function, TYPE (string) should be chose
-from “code”, “markdown”, “raw” and “heading”.  LEVEL is
+from “code”, “hy-code”, “markdown”, “raw” and “heading”.  LEVEL is
 an integer used only when the TYPE is “heading”.
    
 
    
 
@@ -1723,9 +1728,12 @@ argument. The format for the session argument is
 #+END_SRC
    -

    If your code block generates an image, like from an matplotlib plot, then -specify the file to save the image to using the :image argument as in the -example below:

    +

    By default EIN will execute asynchronously so you can continue to work in Emacs, but you may control this behavior via the ein-org-async-p.

    +

    If your code block generates an image, like from an matplotlib plot, ein will +automatically save to a file in the directory specified by +ein:org-inline-image-directory and generate an appropriate inline +link. You can also specify the file to save the image to using by the :image +argument as in the example below:

    #BEGIN_SRC ein :session 8888/Untitled.ipynb :image output.png
 import matplotlib.pyplot as plt
 import numpy as np
@@ -1754,9 +1762,37 @@ the link at the point of cursor.
 [5]See 1.3 Activation in org-mode manual.
 
 
-
    -

    Customization

    +

    Customization

    +
    +
    +variable ein:org-async-p
    +

    If non-nil run ein org-babel source blocks asyncronously.

    +
    + +
    +
    +variable ein:org-inline-image-directory
    +

    Default directory where to save images generated from ein org-babel source blocks.

    +
    + +
    +
    +
    +

    Support for The Hy Language (EXPERIMENTAL)

    +

    New in v0.14, ein has limited support for executing hy code in a notebook +running an ipython kernel. Before trying this feature you will need to install hy +per the quickstart instructions.

    +

    Once you have set up hy in your ipython kernel, open or create a notebook +running this kernel and create or go to an empty cell. You will need to change +the cell type to hy using ein:worksheet-change-cell-type. Once that +is done you can enter hy expressions and they will be correctly evaluated by the +kernel!

    +

    If you are running a hy kernel you can, of course, write hy expressions in +code cells and have the expected results.

    +
    +
    +

    Customization

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

    @@ -1810,8 +1846,8 @@ commands is fine.

    -
    -

    Notebook list

    +
    +

    Notebook list

    variable ein:url-or-port
    @@ -1849,8 +1885,8 @@ in order to make this code work.

    -
    -

    Notebook

    +
    +

    Notebook

    variable ein:worksheet-enable-undo
    @@ -2187,8 +2223,8 @@ to automatically connect any python-mode buffer to the notebook.

    -
    -

    Jedi.el

    +
    +

    Jedi.el

    function ein:jedi-setup
    @@ -2245,8 +2281,8 @@ To use EIN and Jedi together, add the following in your Emacs setup before loadi
    -
    -

    Misc

    +
    +

    Misc

    variable ein:filename-translations
    @@ -2341,17 +2377,17 @@ 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 [6].

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

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

    -
    [6]See the relevant bug report I posted: +
    [6]See the relevant bug report I posted: https://bugs.launchpad.net/nxhtml/+bug/1013794
    @@ -2412,8 +2448,8 @@ a code block, like this:

    gist.

    -
    -

    websocket.el

    +
    +

    websocket.el

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

      @@ -2442,6 +2478,24 @@ everything the log buffer. You can reset the patch and log level with

    Change Log

    +
    +

    v0.14.0

    +

    Surprise! There was never an actual 0.13.1 release, but that’s not to say that +things haven’t been going down around here. Apart from the usual spate of bug fixes, here are the notable changes:

    +
      +
    • Preliminary support for executing hy code from a properly configured notebook.
      • +
    • ob-ein now supports asynchronous execution of code blocks (see +ein:org-async-p)
      • +
    • ob-ein will now write image files to a temporary directory and automatically +generate inline links (see the customizable variable +ein:org-inline-image-directory).
      • +
    • Travis-CI is now working again (mostly!). Only a few basic tests are +implemented, but now we have some basic testing for those of you submitting +pull requests. Rejoice!
      • +
    +

    Also thanks go to @sams, @galeo, @patrickeganfoley, and @ebanner for their much +appreciated contributions.

    +

    v0.13.1