##// END OF EJS Templates
minor docs updates...
Min RK -
Show More
@@ -1,15 +1,15 b''
1 1 .. _core_developer_guide:
2 2
3 ==================================
4 Guide for IPtyhon core Developpers
5 ==================================
3 =================================
4 Guide for IPython core Developers
5 =================================
6 6
7 This guide documents the development of core IPython. Alternatively,
7 This guide documents the development of IPython itself. Alternatively,
8 8 developers of third party tools and libraries that use IPython should see the
9 9 :doc:`../development/index`.
10 10
11 11
12 For instruction on how to make a developer install see devinstall_.
12 For instruction on how to make a developer install see :ref:`devinstall`.
13 13
14 14 .. toctree::
15 15 :maxdepth: 1
@@ -20,9 +20,8 b' For instruction on how to make a developer install see devinstall_.'
20 20 Old Documentation
21 21 =================
22 22
23 Out of date documentation is still available and have been kept for archival
24 reason.
23 Out of date documentation is still available and have been kept for archival purposes.
25 24
26 Developers working on core IPython should also consult the
25 Developers working on IPython should also consult the
27 26 `developer information <https://github.com/ipython/ipython/wiki/Dev:-Index>`_
28 27 on the IPython GitHub wiki.
@@ -47,11 +47,10 b' Dependencies'
47 47 ~~~~~~~~~~~~
48 48
49 49 IPython relies on a number of other Python packages. Installing using a package
50 manager like pip or conda will ensure the necessary packages are installed. If
51 you install manually, it's up to you to make sure dependencies are installed.
52 They're not listed here since a static list would inevitably fall out of date as
53 dependencies may change from release to release and also vary depending on
54 the platform.
50 manager like pip or conda will ensure the necessary packages are installed.
51 Manual installation without dependencies is possible, but not recommended.
52 The dependencies can be viewed with package manager commands,
53 such as :command:`pip show ipython` or :command:`conda info ipython`.
55 54
56 55
57 56 Installing IPython itself
@@ -107,6 +106,7 b' the IPython source tree:'
107 106 $ iptest
108 107
109 108 .. _devinstall:
109
110 110 Installing the development version
111 111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 112
@@ -123,11 +123,9 b' Then do:'
123 123 $ cd ipython
124 124 $ pip install -e .
125 125
126 The `pip install -e .` allow users and developers to be able to follow the
127 development branch as it changes.
128
129 This creates links in the right places and installs the command line script to
130 the appropriate location.
126 The :command:`pip install -e .` command allows users and developers to follow
127 the development branch as it changes by creating links in the right places and
128 installing the command line scripts to the appropriate locations.
131 129
132 130 Then, if you want to update your IPython at any time, do:
133 131
@@ -135,3 +133,10 b' Then, if you want to update your IPython at any time, do:'
135 133
136 134 $ git pull
137 135
136 If the dependencies or entrypoints have changed, you may have to run
137
138 .. code-block:: bash
139
140 $ pip install -e .
141
142 again, but this is infrequent.
General Comments 0
You need to be logged in to leave comments. Login now