Skip to content

Commit a74be10

Browse files
committed
Recommend updating pip in installation doc
Newer versions of `pip` no longer require the `--user` switch.
1 parent 1b50cc9 commit a74be10

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

docs/sources/developers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Testing
2727
StagPy uses tox_ for code testing. Make sure it is installed and up to date on
2828
your system::
2929

30-
% python3 -m pip install -U --user tox
30+
% python3 -m pip install -U tox
3131

3232
.. _tox: https://tox.readthedocs.io
3333

@@ -41,7 +41,7 @@ Documentation
4141
The StagPy documentation is built with Sphinx_. To build it locally, install
4242
and update the needed packages::
4343

44-
% python3 -m pip install -U --user sphinx sphinx-rtd-theme
44+
% python3 -m pip install -U sphinx sphinx-rtd-theme
4545

4646
.. _Sphinx: https://www.sphinx-doc.org
4747

docs/sources/install.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ module to install it (it is bootstrapped within the Python interpreter)::
2121
In case this doesn't work, download the official script
2222
<https://bootstrap.pypa.io/get-pip.py> and run it with ``python3``.
2323

24+
Then, update ``pip`` to the latest version::
25+
26+
% python3 -m pip install -U --user pip
27+
2428
You can then install and/or update StagPy with the following command::
2529

26-
% python3 -m pip install -U --user stagpy
30+
% python3 -m pip install -U stagpy
2731

2832
Make sure that the directory where ``pip`` install package entry-points
2933
(usually ``~/.local/bin``) is in your ``PATH`` environment variable.

0 commit comments

Comments
 (0)