From 43dabeca72c34f655054364dcb0ed46c63bcc9c5 2012-04-19 03:18:16
From: MinRK <benjaminrk@gmail.com>
Date: 2012-04-19 03:18:16
Subject: [PATCH] add note about embed_kernel to embedding docs

---

diff --git a/docs/source/interactive/reference.txt b/docs/source/interactive/reference.txt
index 8fc7660..cb45297 100644
--- a/docs/source/interactive/reference.txt
+++ b/docs/source/interactive/reference.txt
@@ -669,6 +669,14 @@ your Python programs for this to work (detailed examples follow later)::
 
     embed() # this call anywhere in your program will start IPython
 
+.. note::
+
+    As of 0.13, you can embed an IPython *kernel*, for use with qtconsole,
+    etc. via ``IPython.embed_kernel()`` instead of ``IPython.embed()``.
+    It should function just the same as regular embed, but you connect
+    an external frontend rather than IPython starting up in the local
+    terminal.
+
 You can run embedded instances even in code which is itself being run at
 the IPython interactive prompt with '%run <filename>'. Since it's easy
 to get lost as to where you are (in your top-level IPython or in your