Skip to content

Commit fb9f933

Browse files
Mr-SunglassesdonBarbospicnixz
authored
gh-130160: use .. program:: directive for documenting venv CLI (GH-130699)
Co-authored-by: Semyon Moroz <donbarbos@proton.me> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
1 parent 698bab5 commit fb9f933

File tree

1 file changed

+43
-27
lines changed

1 file changed

+43
-27
lines changed

Doc/library/venv.rst

Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -105,36 +105,52 @@ The command, if run with ``-h``, will show the available options::
105105

106106
Creates virtual Python environments in one or more target directories.
107107

108-
positional arguments:
109-
ENV_DIR A directory to create the environment in.
110-
111-
options:
112-
-h, --help show this help message and exit
113-
--system-site-packages
114-
Give the virtual environment access to the system
115-
site-packages dir.
116-
--symlinks Try to use symlinks rather than copies, when
117-
symlinks are not the default for the platform.
118-
--copies Try to use copies rather than symlinks, even when
119-
symlinks are the default for the platform.
120-
--clear Delete the contents of the environment directory
121-
if it already exists, before environment creation.
122-
--upgrade Upgrade the environment directory to use this
123-
version of Python, assuming Python has been
124-
upgraded in-place.
125-
--without-pip Skips installing or upgrading pip in the virtual
126-
environment (pip is bootstrapped by default)
127-
--prompt PROMPT Provides an alternative prompt prefix for this
128-
environment.
129-
--upgrade-deps Upgrade core dependencies (pip) to the latest
130-
version in PyPI
131-
--without-scm-ignore-files
132-
Skips adding SCM ignore files to the environment
133-
directory (Git is supported by default).
134-
135108
Once an environment has been created, you may wish to activate it, e.g. by
136109
sourcing an activate script in its bin directory.
137110

111+
.. _venv-cli:
112+
.. program:: venv
113+
114+
.. option:: ENV_DIR
115+
116+
A required argument specifying the directory to create the environment in.
117+
118+
.. option:: --system-site-packages
119+
120+
Give the virtual environment access to the system site-packages directory.
121+
122+
.. option:: --symlinks
123+
124+
Try to use symlinks rather than copies, when symlinks are not the default for the platform.
125+
126+
.. option:: --copies
127+
128+
Try to use copies rather than symlinks, even when symlinks are the default for the platform.
129+
130+
.. option:: --clear
131+
132+
Delete the contents of the environment directory if it already exists, before environment creation.
133+
134+
.. option:: --upgrade
135+
136+
Upgrade the environment directory to use this version of Python, assuming Python has been upgraded in-place.
137+
138+
.. option:: --without-pip
139+
140+
Skips installing or upgrading pip in the virtual environment (pip is bootstrapped by default).
141+
142+
.. option:: --prompt <PROMPT>
143+
144+
Provides an alternative prompt prefix for this environment.
145+
146+
.. option:: --upgrade-deps
147+
148+
Upgrade core dependencies (pip) to the latest version in PyPI.
149+
150+
.. option:: --without-scm-ignore-files
151+
152+
Skips adding SCM ignore files to the environment directory (Git is supported by default).
153+
138154

139155
.. versionchanged:: 3.4
140156
Installs pip by default, added the ``--without-pip`` and ``--copies``

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy