https://github.com/python/cpython/commit/8cd7f8bf8d6b62f30a8bba1f968eb0c593a8781a
commit: 8cd7f8bf8d6b62f30a8bba1f968eb0c593a8781a
branch: main
author: Kanishk Pachauri <[email protected]>
committer: pfmoore <[email protected]>
date: 2025-02-18T12:09:22Z
summary:
gh-130160: use `.. program::` directive for documenting `ensurepip` CLI
(gh-130253)
files:
M Doc/library/ensurepip.rst
diff --git a/Doc/library/ensurepip.rst b/Doc/library/ensurepip.rst
index 8dfb7ad9c95c3e..fa102c4a080103 100644
--- a/Doc/library/ensurepip.rst
+++ b/Doc/library/ensurepip.rst
@@ -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,26 +63,34 @@ 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.
-Providing both of the script selection options will trigger an exception.
+.. 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``).
+
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
