From 1798d32430d0b3353fdfaac0e89085e70119192a 2016-06-27 18:05:18 From: Carol Willing Date: 2016-06-27 18:05:18 Subject: [PATCH] First pass at editing pr --- diff --git a/docs/requirements.txt b/docs/requirements.txt index 958b938..830b905 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ --e . +-e ../. ipykernel setuptools>=18.5 diff --git a/docs/source/conf.py b/docs/source/conf.py index 013e41f..8e0e6ff 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -162,7 +162,7 @@ default_role = 'literal' # must exist either in Sphinx' static/ path, or in one of the custom paths # given in html_static_path. # html_style = 'default.css' -# html_favicon = 'favicon.ico' + # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -176,6 +176,8 @@ default_role = 'literal' # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] + +# Favicon needs the directory name html_favicon = '_static/favicon.ico' # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/docs/source/coredev/release_process.rst b/docs/source/coredev/release_process.rst index 94255d6..d7b07dc 100644 --- a/docs/source/coredev/release_process.rst +++ b/docs/source/coredev/release_process.rst @@ -91,7 +91,7 @@ release is: ``1.3rc1``. Notice that there is no separator between the '3' and the 'r'. Check the environment variable `$VERSION` as well. -Comment remove the `developpement` entry in `whatsnew/index.rst`. TODO, figure +Comment remove the `development` entry in `whatsnew/index.rst`. TODO, figure out how to make that automatic. 5. Run the `tools/build_release` script @@ -120,7 +120,7 @@ Create and push the tag:: git push origin --tags Update release.py back to `x.y-dev` or `x.y-maint`, and re-add the -`developpement` entry in `docs/source/whatsnew/index.rst` and push:: +`development` entry in `docs/source/whatsnew/index.rst` and push:: git commit -am "back to development" git push origin $BRANCH diff --git a/docs/source/index.rst b/docs/source/index.rst index fd308e1..d64e4b8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,6 +15,7 @@ IPython provides a rich toolkit to help you make the most out of using Python interactively. Its main components are: * A powerful interactive Python shell + * A `Jupyter `_ kernel to work with Python code in Jupyter notebooks and other interactive frontends. @@ -50,11 +51,11 @@ features: The Command line interface inherit all the above functionality and posses -* real multiline editting. +* real multi-line editing. * syntax highlighting as you type -* intgration with command line editor for a better workflow. +* integration with command line editor for a better workflow. The kernel also have its share of feature, when used with a compatible frontend it allows for: @@ -62,7 +63,7 @@ it allows for: * rich display system for object allowing to display Html, Images, Latex,Sounds Video. -* interactive widgets with the use of the ``ipywigets`` package. +* interactive widgets with the use of the ``ipywidgets`` package. This documentation will walk through most of the features of the IPython diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst index d50aaad..78c8536 100644 --- a/docs/source/install/index.rst +++ b/docs/source/install/index.rst @@ -14,18 +14,16 @@ Installation -This sections will guide you into `installing IPython itself `_, and -installing `kernels for jupyter `_ if you are working with -multiple version of Python, or multiple environments. - -To know more, head to the next section. +This sections will guide you through `installing IPython itself `_, and +installing `kernels for Jupyter `_ if you wish to work with +multiple version of Python, or multiple environments. Quick install reminder ~~~~~~~~~~~~~~~~~~~~~~ -Here is a quick reminder of the various commands needed if you are already -familiar with IPython and are just searching to refresh your memory: +Here is a quick reminder of the commands needed for installation if you are +already familiar with IPython and are just searching to refresh your memory: Install IPython: diff --git a/docs/source/install/install.rst b/docs/source/install/install.rst index 4e73713..c6610ff 100644 --- a/docs/source/install/install.rst +++ b/docs/source/install/install.rst @@ -14,10 +14,10 @@ With ``pip`` already installed : $ pip install ipython -This should install IPython as well as all the other dependency required. +This installs IPython as well as its dependencies. -If you try to use IPython with notebooks or the Qt console, you should also install -``jupyter``. +If you want to use IPython with notebooks or the Qt console, you should also +install Jupyter ``pip install jupyter``. @@ -44,15 +44,15 @@ Installing IPython itself ~~~~~~~~~~~~~~~~~~~~~~~~~ IPython requires several dependencies to work correctly, it is not recommended -to install IPython and all it's dependencies manually as this can be quite long and trouble some. -You should likely use the python package manager ``pip`` +to install IPython and all its dependencies manually as this can be quite long and troublesome. +You should use the python package manager ``pip``. Installation using pip ~~~~~~~~~~~~~~~~~~~~~~ -Make sure you have the latest version of :mod:`pip` ( the Python package +Make sure you have the latest version of :mod:`pip` (the Python package manager) installed. If you do not, head to `Pip documentation -`_ and install it first. +`_ and install :mod:`pip` first. The quickest way to get up and running with IPython is to install it with pip: @@ -81,9 +81,9 @@ Try to also avoid any usage of ``easy_install`` that can have similar undesirabl If you are installing to a location (like ``/usr/local``) that requires higher permissions, you may need to run the last command with :command:`sudo`. You can -also install in user specific location by using the ``--user`` flag in conjunction with pip +also install in user specific location by using the ``--user`` flag in conjunction with pip. -To can run IPython's test suite, use the :command:`iptest` command from outside of the IPython source tree: +To run IPython's test suite, use the :command:`iptest` command from outside of the IPython source tree: .. code-block:: bash @@ -127,5 +127,6 @@ Dependencies IPython relies on a number of other Python packages. Installing using a package manager like pip or conda will ensure the necessary packages are installed. If you install manually, it's up to you to make sure dependencies are installed. -They're not listed here, because they may change from release to release, and -depending on platform so a static list will inevitably get out of date. +They're not listed here since a static list would inevitably fall out of date as +dependencies may change from release to release and also vary depending on +the platform. diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 0419b6c..55c54ee 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -219,7 +219,7 @@ different numbers which correspond to the Process ID of the kernel. You can read more about using `jupyter qtconsole `_, and -`ipython notebook `_. There +`jupyter notebook `_. There is also a :ref:`message spec ` which documents the protocol for communication between kernels and clients. diff --git a/docs/source/whatsnew/version5.rst b/docs/source/whatsnew/version5.rst index fc2d1aa..be46ef6 100644 --- a/docs/source/whatsnew/version5.rst +++ b/docs/source/whatsnew/version5.rst @@ -126,8 +126,9 @@ Removed Feature Deprecated Features ------------------- -Some deprecated feature, don't forget to enable ``DeprecationWarning`` as error -of you are using IPython in Continuous Integration setup or in your testing in general: +Some deprecated features are listed in this section. Don't forget to enable +``DeprecationWarning`` as an error if you are using IPython in a Continuous +Integration setup or in your testing in general: .. code-block:: python @@ -135,12 +136,12 @@ of you are using IPython in Continuous Integration setup or in your testing in g warnings.filterwarnings('error', '.*', DeprecationWarning, module='yourmodule.*') -- ``hooks.fix_error_editor`` seem to be unused and is pending deprecation. +- ``hooks.fix_error_editor`` seems unused and is pending deprecation. - `IPython/core/excolors.py:ExceptionColors` is deprecated. -- `IPython.core.InteractiveShell:write()` is deprecated, use `sys.stdout` instead. -- `IPython.core.InteractiveShell:write_err()` is deprecated, use `sys.stderr` instead. -- The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has now no effects. -- The `global_ns` keyword argument of IPython Embed was deprecated, and will now have no effect. Use `module` keyword argument instead. +- `IPython.core.InteractiveShell:write()` is deprecated; use `sys.stdout` instead. +- `IPython.core.InteractiveShell:write_err()` is deprecated; use `sys.stderr` instead. +- The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has no effect. +- The `global_ns` keyword argument of IPython Embed was deprecated, and has no effect. Use `module` keyword argument instead. Known Issues: