Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-130160: use.. program::
directive for documentingvenv
CLI#130699
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
Mr-Sunglasses wants to merge8 commits intopython:mainChoose a base branch fromMr-Sunglasses:venv-use-prog
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+42 −27
Open
Changes fromall commits
Commits
Show all changes
8 commits Select commitHold shift + click to select a range
4dc832e
gh-130160 use `.. program::` directive for documenting `venv` CLI
Mr-Sunglassesc8ee8c3
Merge branch 'main' into venv-use-prog
Mr-Sunglassesa4df05e
Merge branch 'main' into venv-use-prog
Mr-Sunglasses1419051
Update Doc/library/venv.rst
Mr-Sunglasses918676c
Update Doc/library/venv.rst
Mr-Sunglassesf0285a2
Merge branch 'main' into venv-use-prog
Mr-Sunglasses34753d4
Merge branch 'main' into venv-use-prog
Mr-Sunglasses5385791
fix: removed duplicate line from docs
Mr-SunglassesFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -63,6 +63,8 @@ See :pep:`405` for more background on Python virtual environments. | ||
Creating virtual environments | ||
----------------------------- | ||
.. _venv-cli: | ||
.. program:: venv | ||
:ref:`Virtual environments <venv-def>` are created by executing the ``venv`` | ||
module: | ||
@@ -105,36 +107,49 @@ The command, if run with ``-h``, will show the available options:: | ||
Creates virtual Python environments in one or more target directories. | ||
Once an environment has been created, you may wish to activate it, e.g. by | ||
sourcing an activate script in its bin directory. | ||
Mr-Sunglasses marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
.. 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`` | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.