Show More
@@ -162,7 +162,7 b" default_role = 'literal'" | |||||
162 | # must exist either in Sphinx' static/ path, or in one of the custom paths |
|
162 | # must exist either in Sphinx' static/ path, or in one of the custom paths | |
163 | # given in html_static_path. |
|
163 | # given in html_static_path. | |
164 | # html_style = 'default.css' |
|
164 | # html_style = 'default.css' | |
165 | # html_favicon = 'favicon.ico' |
|
165 | ||
166 |
|
166 | |||
167 | # The name for this set of Sphinx documents. If None, it defaults to |
|
167 | # The name for this set of Sphinx documents. If None, it defaults to | |
168 | # "<project> v<release> documentation". |
|
168 | # "<project> v<release> documentation". | |
@@ -176,6 +176,8 b" default_role = 'literal'" | |||||
176 | # relative to this directory. They are copied after the builtin static files, |
|
176 | # relative to this directory. They are copied after the builtin static files, | |
177 | # so a file named "default.css" will overwrite the builtin "default.css". |
|
177 | # so a file named "default.css" will overwrite the builtin "default.css". | |
178 | html_static_path = ['_static'] |
|
178 | html_static_path = ['_static'] | |
|
179 | ||||
|
180 | # Favicon needs the directory name | |||
179 | html_favicon = '_static/favicon.ico' |
|
181 | html_favicon = '_static/favicon.ico' | |
180 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
182 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
181 | # using the given strftime format. |
|
183 | # using the given strftime format. |
@@ -91,7 +91,7 b" release is: ``1.3rc1``. Notice that there is no separator between the '3' and" | |||||
91 | the 'r'. Check the environment variable `$VERSION` as well. |
|
91 | the 'r'. Check the environment variable `$VERSION` as well. | |
92 |
|
92 | |||
93 |
|
93 | |||
94 |
Comment remove the `develop |
|
94 | Comment remove the `development` entry in `whatsnew/index.rst`. TODO, figure | |
95 | out how to make that automatic. |
|
95 | out how to make that automatic. | |
96 |
|
96 | |||
97 | 5. Run the `tools/build_release` script |
|
97 | 5. Run the `tools/build_release` script | |
@@ -120,7 +120,7 b' Create and push the tag::' | |||||
120 | git push origin --tags |
|
120 | git push origin --tags | |
121 |
|
121 | |||
122 | Update release.py back to `x.y-dev` or `x.y-maint`, and re-add the |
|
122 | Update release.py back to `x.y-dev` or `x.y-maint`, and re-add the | |
123 |
`develop |
|
123 | `development` entry in `docs/source/whatsnew/index.rst` and push:: | |
124 |
|
124 | |||
125 | git commit -am "back to development" |
|
125 | git commit -am "back to development" | |
126 | git push origin $BRANCH |
|
126 | git push origin $BRANCH |
@@ -15,6 +15,7 b' IPython provides a rich toolkit to help you make the most out of using Python' | |||||
15 | interactively. Its main components are: |
|
15 | interactively. Its main components are: | |
16 |
|
16 | |||
17 | * A powerful interactive Python shell |
|
17 | * A powerful interactive Python shell | |
|
18 | ||||
18 | * A `Jupyter <http://jupyter.org/>`_ kernel to work with Python code in Jupyter |
|
19 | * A `Jupyter <http://jupyter.org/>`_ kernel to work with Python code in Jupyter | |
19 | notebooks and other interactive frontends. |
|
20 | notebooks and other interactive frontends. | |
20 |
|
21 | |||
@@ -50,11 +51,11 b' features:' | |||||
50 |
|
51 | |||
51 | The Command line interface inherit all the above functionality and posses |
|
52 | The Command line interface inherit all the above functionality and posses | |
52 |
|
53 | |||
53 |
* real multiline edi |
|
54 | * real multi-line editing. | |
54 |
|
55 | |||
55 | * syntax highlighting as you type |
|
56 | * syntax highlighting as you type | |
56 |
|
57 | |||
57 |
* intgration with command line editor for a better workflow. |
|
58 | * integration with command line editor for a better workflow. | |
58 |
|
59 | |||
59 | The kernel also have its share of feature, when used with a compatible frontend |
|
60 | The kernel also have its share of feature, when used with a compatible frontend | |
60 | it allows for: |
|
61 | it allows for: | |
@@ -62,7 +63,7 b' it allows for:' | |||||
62 | * rich display system for object allowing to display Html, Images, Latex,Sounds |
|
63 | * rich display system for object allowing to display Html, Images, Latex,Sounds | |
63 | Video. |
|
64 | Video. | |
64 |
|
65 | |||
65 |
* interactive widgets with the use of the ``ipywigets`` package. |
|
66 | * interactive widgets with the use of the ``ipywidgets`` package. | |
66 |
|
67 | |||
67 |
|
68 | |||
68 | This documentation will walk through most of the features of the IPython |
|
69 | This documentation will walk through most of the features of the IPython |
@@ -14,18 +14,16 b' Installation' | |||||
14 |
|
14 | |||
15 |
|
15 | |||
16 |
|
16 | |||
17 |
This sections will guide you |
|
17 | This sections will guide you through `installing IPython itself <install>`_, and | |
18 |
installing `kernels for |
|
18 | installing `kernels for Jupyter <kernel_install>`_ if you wish to work with | |
19 |
multiple version of Python, or multiple environments. |
|
19 | multiple version of Python, or multiple environments. | |
20 |
|
||||
21 | To know more, head to the next section. |
|
|||
22 |
|
20 | |||
23 |
|
21 | |||
24 | Quick install reminder |
|
22 | Quick install reminder | |
25 | ~~~~~~~~~~~~~~~~~~~~~~ |
|
23 | ~~~~~~~~~~~~~~~~~~~~~~ | |
26 |
|
24 | |||
27 |
Here is a quick reminder of the |
|
25 | Here is a quick reminder of the commands needed for installation if you are | |
28 | familiar with IPython and are just searching to refresh your memory: |
|
26 | already familiar with IPython and are just searching to refresh your memory: | |
29 |
|
27 | |||
30 | Install IPython: |
|
28 | Install IPython: | |
31 |
|
29 |
@@ -14,10 +14,10 b' With ``pip`` already installed :' | |||||
14 |
|
14 | |||
15 | $ pip install ipython |
|
15 | $ pip install ipython | |
16 |
|
16 | |||
17 |
This |
|
17 | This installs IPython as well as its dependencies. | |
18 |
|
18 | |||
19 |
If you t |
|
19 | If you want to use IPython with notebooks or the Qt console, you should also | |
20 | ``jupyter``. |
|
20 | install Jupyter ``pip install jupyter``. | |
21 |
|
21 | |||
22 |
|
22 | |||
23 |
|
23 | |||
@@ -44,15 +44,15 b' Installing IPython itself' | |||||
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
45 |
|
45 | |||
46 | IPython requires several dependencies to work correctly, it is not recommended |
|
46 | IPython requires several dependencies to work correctly, it is not recommended | |
47 |
to install IPython and all it |
|
47 | to install IPython and all its dependencies manually as this can be quite long and troublesome. | |
48 |
You should |
|
48 | You should use the python package manager ``pip``. | |
49 |
|
49 | |||
50 | Installation using pip |
|
50 | Installation using pip | |
51 | ~~~~~~~~~~~~~~~~~~~~~~ |
|
51 | ~~~~~~~~~~~~~~~~~~~~~~ | |
52 |
|
52 | |||
53 |
Make sure you have the latest version of :mod:`pip` ( |
|
53 | Make sure you have the latest version of :mod:`pip` (the Python package | |
54 | manager) installed. If you do not, head to `Pip documentation |
|
54 | manager) installed. If you do not, head to `Pip documentation | |
55 |
<https://pip.pypa.io/en/stable/installing/>` |
|
55 | <https://pip.pypa.io/en/stable/installing/>`_ and install :mod:`pip` first. | |
56 |
|
56 | |||
57 | The quickest way to get up and running with IPython is to install it with pip: |
|
57 | The quickest way to get up and running with IPython is to install it with pip: | |
58 |
|
58 | |||
@@ -81,9 +81,9 b' Try to also avoid any usage of ``easy_install`` that can have similar undesirabl' | |||||
81 |
|
81 | |||
82 | If you are installing to a location (like ``/usr/local``) that requires higher |
|
82 | If you are installing to a location (like ``/usr/local``) that requires higher | |
83 | permissions, you may need to run the last command with :command:`sudo`. You can |
|
83 | permissions, you may need to run the last command with :command:`sudo`. You can | |
84 | also install in user specific location by using the ``--user`` flag in conjunction with pip |
|
84 | also install in user specific location by using the ``--user`` flag in conjunction with pip. | |
85 |
|
85 | |||
86 |
To |
|
86 | To run IPython's test suite, use the :command:`iptest` command from outside of the IPython source tree: | |
87 |
|
87 | |||
88 | .. code-block:: bash |
|
88 | .. code-block:: bash | |
89 |
|
89 | |||
@@ -127,5 +127,6 b' Dependencies' | |||||
127 | IPython relies on a number of other Python packages. Installing using a package |
|
127 | IPython relies on a number of other Python packages. Installing using a package | |
128 | manager like pip or conda will ensure the necessary packages are installed. If |
|
128 | manager like pip or conda will ensure the necessary packages are installed. If | |
129 | you install manually, it's up to you to make sure dependencies are installed. |
|
129 | you install manually, it's up to you to make sure dependencies are installed. | |
130 | They're not listed here, because they may change from release to release, and |
|
130 | They're not listed here since a static list would inevitably fall out of date as | |
131 | depending on platform so a static list will inevitably get out of date. |
|
131 | dependencies may change from release to release and also vary depending on | |
|
132 | the platform. |
@@ -219,7 +219,7 b' different numbers which correspond to the Process ID of the kernel.' | |||||
219 |
|
219 | |||
220 | You can read more about using `jupyter qtconsole |
|
220 | You can read more about using `jupyter qtconsole | |
221 | <http://jupyter.org/qtconsole/>`_, and |
|
221 | <http://jupyter.org/qtconsole/>`_, and | |
222 |
` |
|
222 | `jupyter notebook <http://jupyter-notebook.readthedocs.io/en/latest/>`_. There | |
223 | is also a :ref:`message spec <messaging>` which documents the protocol for |
|
223 | is also a :ref:`message spec <messaging>` which documents the protocol for | |
224 | communication between kernels |
|
224 | communication between kernels | |
225 | and clients. |
|
225 | and clients. |
@@ -126,8 +126,9 b' Removed Feature' | |||||
126 | Deprecated Features |
|
126 | Deprecated Features | |
127 | ------------------- |
|
127 | ------------------- | |
128 |
|
128 | |||
129 | Some deprecated feature, don't forget to enable ``DeprecationWarning`` as error |
|
129 | Some deprecated features are listed in this section. Don't forget to enable | |
130 | of you are using IPython in Continuous Integration setup or in your testing in general: |
|
130 | ``DeprecationWarning`` as an error if you are using IPython in a Continuous | |
|
131 | Integration setup or in your testing in general: | |||
131 |
|
132 | |||
132 | .. code-block:: python |
|
133 | .. code-block:: python | |
133 |
|
134 | |||
@@ -135,12 +136,12 b' of you are using IPython in Continuous Integration setup or in your testing in g' | |||||
135 | warnings.filterwarnings('error', '.*', DeprecationWarning, module='yourmodule.*') |
|
136 | warnings.filterwarnings('error', '.*', DeprecationWarning, module='yourmodule.*') | |
136 |
|
137 | |||
137 |
|
138 | |||
138 |
- ``hooks.fix_error_editor`` seem |
|
139 | - ``hooks.fix_error_editor`` seems unused and is pending deprecation. | |
139 | - `IPython/core/excolors.py:ExceptionColors` is deprecated. |
|
140 | - `IPython/core/excolors.py:ExceptionColors` is deprecated. | |
140 |
- `IPython.core.InteractiveShell:write()` is deprecated |
|
141 | - `IPython.core.InteractiveShell:write()` is deprecated; use `sys.stdout` instead. | |
141 |
- `IPython.core.InteractiveShell:write_err()` is deprecated |
|
142 | - `IPython.core.InteractiveShell:write_err()` is deprecated; use `sys.stderr` instead. | |
142 |
- The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has no |
|
143 | - The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has no effect. | |
143 |
- The `global_ns` keyword argument of IPython Embed was deprecated, and |
|
144 | - The `global_ns` keyword argument of IPython Embed was deprecated, and has no effect. Use `module` keyword argument instead. | |
144 |
|
145 | |||
145 |
|
146 | |||
146 | Known Issues: |
|
147 | Known Issues: |
General Comments 0
You need to be logged in to leave comments.
Login now