Skip to content

Update Development Getting Started guide to reflect reality #10449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 7, 2021
Merged

Update Development Getting Started guide to reflect reality #10449

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
354d92f
Update Development Getting Started guide to reflect reality
pradyunsg Sep 8, 2021
1d0f4ea
Merge branch 'main' into tweak-dev-getting-started
pradyunsg Nov 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/html/development/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ You can then invoke your local source tree pip normally.

.. code-block:: shell

virtualenv .venv # You can also use "python -m venv .venv"
python -m venv .venv
source .venv/bin/activate
python -m pip install -e .
python -m pip --version
Expand All @@ -51,7 +51,7 @@ You can then invoke your local source tree pip normally.

.. code-block:: shell

virtualenv .venv # You can also use "py -m venv .venv"
py -m venv .venv
.venv\Scripts\activate
py -m pip install -e .
py -m pip --version
Expand Down Expand Up @@ -94,9 +94,10 @@ can select tests using the various ways that pytest provides:
$ # Using keywords
$ tox -e py36 -- -k "install and not wheel"

Running pip's test suite requires supported version control tools (subversion,
bazaar, git, and mercurial) to be installed. If you are missing one of the VCS
tools, you can tell pip to skip those tests:
Running pip's entire test suite requires supported version control tools
(subversion, bazaar, git, and mercurial) to be installed. If you are missing
any of these VCS, those tests should be skipped automatically. You can also
explicitly tell pytest to skip those tests:

.. code-block:: console

Expand Down