##// END OF EJS Templates
Fix broken links on install/index.rst...
Gavin Cooper -
Show More
@@ -1,58 +1,58 b''
1 1 .. _install_index:
2 2
3 3 ============
4 4 Installation
5 5 ============
6 6
7 7 .. toctree::
8 8 :maxdepth: 3
9 9 :hidden:
10 10
11 11
12 12 install
13 13 kernel_install
14 14
15 15
16 16
17 This sections will guide you through `installing IPython itself <install>`_, and
18 installing `kernels for Jupyter <kernel_install>`_ if you wish to work with
17 This sections will guide you through :ref:`installing IPython itself <install>`, and
18 installing :ref:`kernels for Jupyter <kernel_install>` if you wish to work with
19 19 multiple version of Python, or multiple environments.
20 20
21 21
22 22 Quick install reminder
23 23 ~~~~~~~~~~~~~~~~~~~~~~
24 24
25 25 Here is a quick reminder of the commands needed for installation if you are
26 26 already familiar with IPython and are just searching to refresh your memory:
27 27
28 28 Install IPython:
29 29
30 30 .. code-block:: bash
31 31
32 32 $ pip install ipython
33 33
34 34
35 35 Install and register an IPython kernel with Jupyter:
36 36
37 37
38 38 .. code-block:: bash
39 39
40 40 $ python -m pip install ipykernel
41 41
42 42 $ python -m ipykernel install [--user] [--name <machine-readable-name>] [--display-name <"User Friendly Name">]
43 43
44 44 for more help see
45 45
46 46 .. code-block:: bash
47 47
48 48 $ python -m ipykernel install --help
49 49
50 50
51 51
52 52 .. seealso::
53 53
54 54 `Installing Jupyter <http://jupyter.readthedocs.io/en/latest/install.html>`__
55 55 The Notebook, nbconvert, and many other former pieces of IPython are now
56 56 part of Project Jupyter.
57 57
58 58
@@ -1,142 +1,144 b''
1 .. _install:
2
1 3 Installing IPython
2 4 ==================
3 5
4 6
5 7 IPython requires Python 2.7 or β‰₯ 3.3.
6 8
7 9
8 10 Quick Install
9 11 -------------
10 12
11 13 With ``pip`` already installed :
12 14
13 15 .. code-block:: bash
14 16
15 17 $ pip install ipython
16 18
17 19 This installs IPython as well as its dependencies.
18 20
19 21 If you want to use IPython with notebooks or the Qt console, you should also
20 22 install Jupyter ``pip install jupyter``.
21 23
22 24
23 25
24 26 Overview
25 27 --------
26 28
27 29 This document describes in detail the steps required to install IPython. For a
28 30 few quick ways to get started with package managers or full Python
29 31 distributions, see `the install page <http://ipython.org/install.html>`_ of the
30 32 IPython website.
31 33
32 34 Please let us know if you have problems installing IPython or any of its
33 35 dependencies.
34 36
35 37 IPython and most dependencies should be installed via :command:`pip`.
36 38 In many scenarios, this is the simplest method of installing Python packages.
37 39 More information about :mod:`pip` can be found on
38 40 `its PyPI page <https://pip.pypa.io>`__.
39 41
40 42
41 43 More general information about installing Python packages can be found in
42 44 `Python's documentation <http://docs.python.org>`_.
43 45
44 46 .. _dependencies:
45 47
46 48 Dependencies
47 49 ~~~~~~~~~~~~
48 50
49 51 IPython relies on a number of other Python packages. Installing using a package
50 52 manager like pip or conda will ensure the necessary packages are installed.
51 53 Manual installation without dependencies is possible, but not recommended.
52 54 The dependencies can be viewed with package manager commands,
53 55 such as :command:`pip show ipython` or :command:`conda info ipython`.
54 56
55 57
56 58 Installing IPython itself
57 59 ~~~~~~~~~~~~~~~~~~~~~~~~~
58 60
59 61 IPython requires several dependencies to work correctly, it is not recommended
60 62 to install IPython and all its dependencies manually as this can be quite long
61 63 and troublesome. You should use the python package manager ``pip``.
62 64
63 65 Installation using pip
64 66 ~~~~~~~~~~~~~~~~~~~~~~
65 67
66 68 Make sure you have the latest version of :mod:`pip` (the Python package
67 69 manager) installed. If you do not, head to `Pip documentation
68 70 <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first.
69 71
70 72 The quickest way to get up and running with IPython is to install it with pip:
71 73
72 74 .. code-block:: bash
73 75
74 76 $ pip install ipython
75 77
76 78 That's it.
77 79
78 80
79 81 Installation from source
80 82 ~~~~~~~~~~~~~~~~~~~~~~~~
81 83
82 84 If you don't want to use :command:`pip`, or don't have it installed,
83 85 grab the latest stable tarball of IPython `from PyPI
84 86 <https://pypi.python.org/pypi/ipython>`__. Then do the following:
85 87
86 88 .. code-block:: bash
87 89
88 90 $ tar -xzf ipython.tar.gz
89 91 $ cd ipython
90 92 $ pip install .
91 93
92 94 Do not invoke ``setup.py`` directly as this can have undesirable consequences
93 95 for further upgrades. Try to also avoid any usage of ``easy_install`` that can
94 96 have similar undesirable consequences.
95 97
96 98 If you are installing to a location (like ``/usr/local``) that requires higher
97 99 permissions, you may need to run the last command with :command:`sudo`. You can
98 100 also install in user specific location by using the ``--user`` flag in
99 101 conjunction with pip.
100 102
101 103 To run IPython's test suite, use the :command:`iptest` command from outside of
102 104 the IPython source tree:
103 105
104 106 .. code-block:: bash
105 107
106 108 $ iptest
107 109
108 110 .. _devinstall:
109 111
110 112 Installing the development version
111 113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 114
113 115 It is also possible to install the development version of IPython from our
114 116 `Git <http://git-scm.com/>`_ source code repository. To do this you will
115 117 need to have Git installed on your system.
116 118
117 119
118 120 Then do:
119 121
120 122 .. code-block:: bash
121 123
122 124 $ git clone https://github.com/ipython/ipython.git
123 125 $ cd ipython
124 126 $ pip install -e .
125 127
126 128 The :command:`pip install -e .` command allows users and developers to follow
127 129 the development branch as it changes by creating links in the right places and
128 130 installing the command line scripts to the appropriate locations.
129 131
130 132 Then, if you want to update your IPython at any time, do:
131 133
132 134 .. code-block:: bash
133 135
134 136 $ git pull
135 137
136 138 If the dependencies or entrypoints have changed, you may have to run
137 139
138 140 .. code-block:: bash
139 141
140 142 $ pip install -e .
141 143
142 144 again, but this is infrequent.
General Comments 0
You need to be logged in to leave comments. Login now