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 venv CLI (GH-130699)

Browse source 
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
This commit is contained in:
Kanishk Pachauri 2025-06-30 11:11:57 +05:30 • committed by GitHub
parent 698bab5a40
commit fb9f933b8e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 43 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

70
Doc/library/venv.rst
View file

@ -105,36 +105,52 @@ The command, if run with ``-h``, will show the available options::
Creates virtual Python environments in one or more target directories.
positional arguments:
ENV_DIR A directory to create the environment in.
options:
-h, --help show this help message and exit
--system-site-packages
Give the virtual environment access to the system
site-packages dir.
--symlinks Try to use symlinks rather than copies, when
symlinks are not the default for the platform.
--copies Try to use copies rather than symlinks, even when
symlinks are the default for the platform.
--clear Delete the contents of the environment directory
if it already exists, before environment creation.
--upgrade Upgrade the environment directory to use this
version of Python, assuming Python has been
upgraded in-place.
--without-pip Skips installing or upgrading pip in the virtual
environment (pip is bootstrapped by default)
--prompt PROMPT Provides an alternative prompt prefix for this
environment.
--upgrade-deps Upgrade core dependencies (pip) to the latest
version in PyPI
--without-scm-ignore-files
Skips adding SCM ignore files to the environment
directory (Git is supported by default).
Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.
.. _venv-cli:
.. program:: venv
.. option:: ENV_DIR
A required argument specifying the directory to create the environment in.
.. option:: --system-site-packages
Give the virtual environment access to the system site-packages directory.
.. option:: --symlinks
Try to use symlinks rather than copies, when symlinks are not the default for the platform.
.. option:: --copies
Try to use copies rather than symlinks, even when symlinks are the default for the platform.
.. option:: --clear
Delete the contents of the environment directory if it already exists, before environment creation.
.. option:: --upgrade
Upgrade the environment directory to use this version of Python, assuming Python has been upgraded in-place.
.. option:: --without-pip
Skips installing or upgrading pip in the virtual environment (pip is bootstrapped by default).
.. option:: --prompt <PROMPT>
Provides an alternative prompt prefix for this environment.
.. option:: --upgrade-deps
Upgrade core dependencies (pip) to the latest version in PyPI.
.. option:: --without-scm-ignore-files
Skips adding SCM ignore files to the environment directory (Git is supported by default).
.. versionchanged:: 3.4
Installs pip by default, added the ``--without-pip`` and ``--copies``