mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-07 19:35:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-130160: use .. program:: directive for documenting ensurepip CLI (gh-130253)

Browse source
This commit is contained in:
Kanishk Pachauri 2025-02-18 17:39:22 +05:30 • committed by GitHub
parent 2e3e65380b
commit 8cd7f8bf8d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

33
Doc/library/ensurepip.rst
View file

@ -43,6 +43,8 @@ when creating a virtual environment) or after explicitly uninstalling
Command line interface
----------------------
.. program:: ensurepip
The command line interface is invoked using the interpreter's ``-m`` switch.
The simplest possible invocation is::
@ -61,27 +63,35 @@ By default, ``pip`` is installed into the current virtual environment
active virtual environment). The installation location can be controlled
through two additional command line options:
* :samp:`--root {dir}`: Installs ``pip`` relative to the given root directory
rather than the root of the currently active virtual environment (if any)
or the default root for the current Python installation.
* ``--user``: Installs ``pip`` into the user site packages directory rather
than globally for the current Python installation (this option is not
permitted inside an active virtual environment).
.. option:: --root <dir>
Installs ``pip`` relative to the given root directory rather than the root
of the currently active virtual environment (if any) or the default root
for the current Python installation.
.. option:: --user
Installs ``pip`` into the user site packages directory rather than globally
for the current Python installation (this option is not permitted inside an
active virtual environment).
By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where
X.Y stands for the version of Python used to invoke ``ensurepip``). The
scripts installed can be controlled through two additional command line
options:
* ``--altinstall``: if an alternate installation is requested, the ``pipX``
script will *not* be installed.
.. option:: --altinstall
* ``--default-pip``: if a "default pip" installation is requested, the
``pip`` script will be installed in addition to the two regular scripts.
If an alternate installation is requested, the ``pipX`` script will *not* be
installed.
.. option:: --default-pip
If a "default pip" installation is requested, the ``pip`` script will be
installed in addition to the two regular scripts.
Providing both of the script selection options will trigger an exception.
Module API
----------
@ -136,3 +146,4 @@ Module API
``pip``, but other software should not assume those dependencies will
always be present by default (as the dependencies may be removed in a
future version of ``pip``).