Skip to content

Commit 28f77d7

Browse files
authored
Include nox install instructions in Getting Started dev doc (#12001)
1 parent d9ec9e3 commit 28f77d7

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

docs/html/development/getting-started.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,32 +27,42 @@ Development Environment
2727
pip is a command line application written in Python. For developing pip,
2828
you should `install Python`_ on your computer.
2929

30-
For developing pip, you need to install :pypi:`nox`. Often, you can run
31-
``python -m pip install nox`` to install and use it.
30+
For developing pip, you need to install :pypi:`nox`. The full development setup would then be:
3231

32+
.. tab:: Unix/macOS
33+
34+
.. code-block:: shell
35+
36+
python -m venv .venv
37+
source .venv/bin/activate
38+
python -m pip install nox
39+
40+
.. tab:: Windows
41+
42+
.. code-block:: shell
43+
44+
py -m venv .venv
45+
.venv\Scripts\activate
46+
py -m pip install nox
3347
3448
Running pip From Source Tree
3549
============================
3650

3751
To run the pip executable from your source tree during development, install pip
3852
locally using editable installation (inside a virtualenv).
39-
You can then invoke your local source tree pip normally.
53+
You can then invoke your local source tree pip normally (be sure virtualenv is active).
4054

4155
.. tab:: Unix/macOS
4256

4357
.. code-block:: shell
4458
45-
python -m venv .venv
46-
source .venv/bin/activate
4759
python -m pip install -e .
4860
python -m pip --version
4961
5062
.. tab:: Windows
5163

5264
.. code-block:: shell
5365
54-
py -m venv .venv
55-
.venv\Scripts\activate
5666
py -m pip install -e .
5767
py -m pip --version
5868

news/no-issue.trivial.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Added seperate instructions for installing ``nox`` in the ``docs/development/getting-started.rst`` doc. and slight update
2+
to the below ``Running pip From Source Tree`` section.

0 commit comments

Comments
 (0)