From 28f77d7618d0acbae3242c50fc1e475cbafebd1d Mon Sep 17 00:00:00 2001 From: "Awit (Ah-Wit) Ghirmai" <107564270+awitghirmai@users.noreply.github.com> Date: Wed, 26 Apr 2023 12:52:14 -0600 Subject: [PATCH] Include nox install instructions in Getting Started dev doc (#12001) --- docs/html/development/getting-started.rst | 34 +++++++++++++++-------- news/no-issue.trivial.rst | 2 ++ 2 files changed, 24 insertions(+), 12 deletions(-) create mode 100644 news/no-issue.trivial.rst diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index 730f5ece0..e248259f0 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -27,16 +27,7 @@ Development Environment pip is a command line application written in Python. For developing pip, you should `install Python`_ on your computer. -For developing pip, you need to install :pypi:`nox`. Often, you can run -``python -m pip install nox`` to install and use it. - - -Running pip From Source Tree -============================ - -To run the pip executable from your source tree during development, install pip -locally using editable installation (inside a virtualenv). -You can then invoke your local source tree pip normally. +For developing pip, you need to install :pypi:`nox`. The full development setup would then be: .. tab:: Unix/macOS @@ -44,8 +35,7 @@ You can then invoke your local source tree pip normally. python -m venv .venv source .venv/bin/activate - python -m pip install -e . - python -m pip --version + python -m pip install nox .. tab:: Windows @@ -53,6 +43,26 @@ You can then invoke your local source tree pip normally. py -m venv .venv .venv\Scripts\activate + py -m pip install nox + +Running pip From Source Tree +============================ + +To run the pip executable from your source tree during development, install pip +locally using editable installation (inside a virtualenv). +You can then invoke your local source tree pip normally (be sure virtualenv is active). + +.. tab:: Unix/macOS + + .. code-block:: shell + + python -m pip install -e . + python -m pip --version + +.. tab:: Windows + + .. code-block:: shell + py -m pip install -e . py -m pip --version diff --git a/news/no-issue.trivial.rst b/news/no-issue.trivial.rst new file mode 100644 index 000000000..6440f6687 --- /dev/null +++ b/news/no-issue.trivial.rst @@ -0,0 +1,2 @@ +Added seperate instructions for installing ``nox`` in the ``docs/development/getting-started.rst`` doc. and slight update +to the below ``Running pip From Source Tree`` section.