diff options
| author | Awit (Ah-Wit) Ghirmai <107564270+awitghirmai@users.noreply.github.com> | 2023-04-26 12:52:14 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-26 12:52:14 -0600 |
| commit | 28f77d7618d0acbae3242c50fc1e475cbafebd1d (patch) | |
| tree | 8846a7300113bd010c243ae5e2319ff235851080 | |
| parent | d9ec9e3eb8616bd206dda5a2749b9d1ccefdd2b5 (diff) | |
| download | pip-28f77d7618d0acbae3242c50fc1e475cbafebd1d.tar.gz | |
Include nox install instructions in Getting Started dev doc (#12001)
| -rw-r--r-- | docs/html/development/getting-started.rst | 24 | ||||
| -rw-r--r-- | news/no-issue.trivial.rst | 2 |
2 files changed, 19 insertions, 7 deletions
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,23 +27,35 @@ 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. +For developing pip, you need to install :pypi:`nox`. The full development setup would then be: +.. tab:: Unix/macOS + + .. code-block:: shell + + python -m venv .venv + source .venv/bin/activate + python -m pip install nox + +.. tab:: Windows + + .. code-block:: shell + + 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. +You can then invoke your local source tree pip normally (be sure virtualenv is active). .. tab:: Unix/macOS .. code-block:: shell - python -m venv .venv - source .venv/bin/activate python -m pip install -e . python -m pip --version @@ -51,8 +63,6 @@ You can then invoke your local source tree pip normally. .. code-block:: shell - py -m venv .venv - .venv\Scripts\activate 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. |