From 8e9ef24ae47465efd27b25da13715f3f84953cd9 Mon Sep 17 00:00:00 2001 From: Florian Rathgeber Date: Sat, 27 Oct 2018 16:44:57 +0100 Subject: [PATCH 1/5] Add instructions for running pip from source to docs --- docs/html/development/getting-started.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index 96068c6d99e..d583adc158a 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -17,6 +17,16 @@ and ensuring reproducible environments for linting and building documentation. For developing pip, you need to install ``tox`` on your system. Often, you can just do ``python -m pip install tox`` to install and use it. +Running pip From Source Tree +---------------------------- + +To run the pip executable from your source tree during development, run the +executable from a ``tox`` environment, after having run the tests: + +.. code-block:: console + + $ .tox/py36/bin/pip --version + Running Tests ------------- From 6e9b0047b389e001896d8e48adad424ced8a3299 Mon Sep 17 00:00:00 2001 From: Florian Rathgeber Date: Sat, 27 Oct 2018 19:46:49 +0100 Subject: [PATCH 2/5] Add news entry --- news/5949.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 news/5949.doc diff --git a/news/5949.doc b/news/5949.doc new file mode 100644 index 00000000000..fae71a81d71 --- /dev/null +++ b/news/5949.doc @@ -0,0 +1 @@ +Adds instructions for running pip from source to Development documentation. \ No newline at end of file From afe41d4c07db4b42f0c0154ced21ae0b7cf66958 Mon Sep 17 00:00:00 2001 From: Florian Rathgeber Date: Sun, 28 Oct 2018 14:11:01 +0000 Subject: [PATCH 3/5] And some notes and caveats --- docs/html/development/getting-started.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index d583adc158a..146559a1d52 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -20,13 +20,28 @@ just do ``python -m pip install tox`` to install and use it. Running pip From Source Tree ---------------------------- -To run the pip executable from your source tree during development, run the -executable from a ``tox`` environment, after having run the tests: +To run the pip executable from your source tree using the currently active +virtualenv (or conda environment) during development, run from a ``tox`` +environment, after having run the tests at least once: .. code-block:: console $ .tox/py36/bin/pip --version +.. note:: + You need to do run ``tox -e py36 --recreate`` after any changes to your + virtualenv if using pip like this. + +.. note:: + You can use any other tox environment instead of ``py36``. + +.. note:: + ``tox -e py36 --notest`` can be used, if running tests is not a concern. + +.. note:: + An easier alternative is running ``python src/pip``, however there are + `edge cases `_ that may not work. + Running Tests ------------- From 044fdda9422981d1a330ff935acecb943083ed9c Mon Sep 17 00:00:00 2001 From: Florian Rathgeber Date: Sun, 28 Oct 2018 14:22:59 +0000 Subject: [PATCH 4/5] Switch to running src/pip now #5481 is merged --- docs/html/development/getting-started.rst | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index 146559a1d52..3a2c3e46007 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -21,26 +21,11 @@ Running pip From Source Tree ---------------------------- To run the pip executable from your source tree using the currently active -virtualenv (or conda environment) during development, run from a ``tox`` -environment, after having run the tests at least once: +virtualenv during development, run pip from the ``src`` directory: .. code-block:: console - $ .tox/py36/bin/pip --version - -.. note:: - You need to do run ``tox -e py36 --recreate`` after any changes to your - virtualenv if using pip like this. - -.. note:: - You can use any other tox environment instead of ``py36``. - -.. note:: - ``tox -e py36 --notest`` can be used, if running tests is not a concern. - -.. note:: - An easier alternative is running ``python src/pip``, however there are - `edge cases `_ that may not work. + $ python src/pip --version Running Tests ------------- From b911f6536527ff7b30c7beb880cc0f74c27506b2 Mon Sep 17 00:00:00 2001 From: Florian Rathgeber Date: Sun, 28 Oct 2018 23:48:19 +0000 Subject: [PATCH 5/5] Remove mention of virtualenv --- docs/html/development/getting-started.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index 3a2c3e46007..a5971d883e1 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -20,8 +20,8 @@ just do ``python -m pip install tox`` to install and use it. Running pip From Source Tree ---------------------------- -To run the pip executable from your source tree using the currently active -virtualenv during development, run pip from the ``src`` directory: +To run the pip executable from your source tree during development, run pip +from the ``src`` directory: .. code-block:: console