Skip to content

Commit f7f1448

Browse files
miss-islingtonMr-SunglassesdonBarbospicnixz
authored
[3.13] gh-130160: use .. program:: directive for documenting venv CLI (GH-130699) (#136551)
gh-130160: use `.. program::` directive for documenting `venv` CLI (GH-130699) (cherry picked from commit fb9f933) Co-authored-by: Kanishk Pachauri <[email protected]> Co-authored-by: Semyon Moroz <[email protected]> Co-authored-by: Bénédikt Tran <[email protected]>
1 parent cba2974 commit f7f1448

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
@@ -102,36 +102,52 @@ The command, if run with ``-h``, will show the available options::
102102

103103
Creates virtual Python environments in one or more target directories.
104104

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

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

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

0 commit comments

Comments
 (0)