From c82b8519d3167ad9aae29ca4ea8dc9271550d7c6 2015-10-12 16:41:51
From: Matthias Bussonnier <bussonniermatthias@gmail.com>
Date: 2015-10-12 16:41:51
Subject: [PATCH] Merge pull request #8877 from minrk/install-kernel-doc

document kernel installation in multiple environments
---

diff --git a/docs/source/install/kernel_install.rst b/docs/source/install/kernel_install.rst
index 3ba1e41..a5bfea6 100644
--- a/docs/source/install/kernel_install.rst
+++ b/docs/source/install/kernel_install.rst
@@ -1,15 +1,51 @@
 .. _kernel_install:
 
-Kernel Installation
--------------------
+Installing the IPython kernel
+=============================
 
-IPython can be installed (different python versions, virtualenv or conda 
-environments) as a kernel by following these steps:
+IPython can be installed (different python versions, virtualenv or conda
+environments) as a kernel for Jupyter by following these steps:
+
+* make sure that the desired python installation is active
+  (e.g. activate the environment, or use absolute paths)
+  and ipykernel is installed
+* run once ``ipython kernel install --user``,
+  or ``python -m ipykernel install --user`` to ensure a specific Python installation is used.
 
-* make sure that the desired python installation is active (e.g. activate the environment)
-  and ipython is installed
-* run once ``ipython kernelspec install-self --user`` (or ``ipython2 ...`` or ``ipython3 ...``
-  if you want to install specific python versions)
 
 The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file for the current python installation. Kernel spec files are JSON files, which can be viewed and changed with a
 normal text editor.
+
+For example:
+
+.. sourcecode:: bash
+
+    source activate kernel-environment
+    ipython kernel install --user
+    source deactivate kernel-environment
+
+or
+
+.. sourcecode:: bash
+
+    ~/envs/kernel-environment/python -m ipykernel install --user
+
+
+.. _multiple_kernel_install:
+
+Multiple IPython installs
+=========================
+
+If you want to have multiple IPython kernels for different environments,
+you will need to specify unique names for the kernelspecs,
+and you may also want to specify the display name of those kernels,
+so that you can clearly see which is which in the notebook menus:
+
+.. sourcecode:: bash
+
+    source activate myenv
+    ipython kernel install --user --name myenv --display-name "Python (myenv)"
+    source activate other-env
+    ipython kernel install --user --name other-env --display-name "Python (other-env)"
+    source deactivate
+