Merge pull request #5949 from kynan/extend-docs

Add instructions for running pip from source to docs
pypa · Nov 13, 2018 · 507b90e · 507b90e
2 parents b8ee4a6 + b911f65
commit 507b90e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git 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 pip
+from the ``src`` directory:
+
+.. code-block:: console
+
+    $ python src/pip --version
+
 Running Tests
 -------------
 

diff --git a/news/5949.doc b/news/5949.doc
@@ -0,0 +1 @@
+Adds instructions for running pip from source to Development documentation.