From 6f44adf605ed3e55fcbab07d3c0a007a4b6e4a94 2016-07-06 12:46:54 From: Thomas Kluyver Date: 2016-07-06 12:46:54 Subject: [PATCH] Merge pull request #9708 from minrk/docs-followup minor docs updates --- diff --git a/docs/source/coredev/index.rst b/docs/source/coredev/index.rst index fa86111..d4331a0 100644 --- a/docs/source/coredev/index.rst +++ b/docs/source/coredev/index.rst @@ -1,15 +1,15 @@ .. _core_developer_guide: -================================== -Guide for IPtyhon core Developpers -================================== +================================= +Guide for IPython core Developers +================================= -This guide documents the development of core IPython. Alternatively, +This guide documents the development of IPython itself. Alternatively, developers of third party tools and libraries that use IPython should see the :doc:`../development/index`. -For instruction on how to make a developer install see devinstall_. +For instruction on how to make a developer install see :ref:`devinstall`. .. toctree:: :maxdepth: 1 @@ -20,9 +20,8 @@ For instruction on how to make a developer install see devinstall_. Old Documentation ================= -Out of date documentation is still available and have been kept for archival -reason. +Out of date documentation is still available and have been kept for archival purposes. -Developers working on core IPython should also consult the +Developers working on IPython should also consult the `developer information `_ on the IPython GitHub wiki. diff --git a/docs/source/install/install.rst b/docs/source/install/install.rst index 769e307..32ab774 100644 --- a/docs/source/install/install.rst +++ b/docs/source/install/install.rst @@ -47,11 +47,10 @@ 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 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. +manager like pip or conda will ensure the necessary packages are installed. +Manual installation without dependencies is possible, but not recommended. +The dependencies can be viewed with package manager commands, +such as :command:`pip show ipython` or :command:`conda info ipython`. Installing IPython itself @@ -107,6 +106,7 @@ the IPython source tree: $ iptest .. _devinstall: + Installing the development version ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -123,11 +123,9 @@ Then do: $ cd ipython $ pip install -e . -The `pip install -e .` allow users and developers to be able to follow the -development branch as it changes. - -This creates links in the right places and installs the command line script to -the appropriate location. +The :command:`pip install -e .` command allows users and developers to follow +the development branch as it changes by creating links in the right places and +installing the command line scripts to the appropriate locations. Then, if you want to update your IPython at any time, do: @@ -135,3 +133,10 @@ Then, if you want to update your IPython at any time, do: $ git pull +If the dependencies or entrypoints have changed, you may have to run + +.. code-block:: bash + + $ pip install -e . + +again, but this is infrequent.