summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-03-01 15:07:31 (GMT)
committerGitHub <noreply@github.com>2021-03-01 15:07:31 (GMT)
commit6900a515c8410795f9a8ef2ad38740847a919b6d (patch)
treec760a603eb5f7d7e2f6a0e050e21dd0d02f54c70
parent643939a07e480ed88a6eca9793157f1c695a418e (diff)
downloadcpython-6900a515c8410795f9a8ef2ad38740847a919b6d.zip
cpython-6900a515c8410795f9a8ef2ad38740847a919b6d.tar.gz
cpython-6900a515c8410795f9a8ef2ad38740847a919b6d.tar.bz2
[3.8] [doc] Document VIRTUAL_ENV environment variable (GH-21970) (GH-24363)
(cherry picked from commit 3584d4b64a5373440f78237eac734831cfd83f79)
-rw-r--r--Doc/using/venv-create.inc4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/using/venv-create.inc b/Doc/using/venv-create.inc
index c81aaf1..b4089e6 100644
--- a/Doc/using/venv-create.inc
+++ b/Doc/using/venv-create.inc
@@ -121,6 +121,10 @@ directory containing the virtual environment):
| | PowerShell | PS C:\\> <venv>\\Scripts\\Activate.ps1 |
+-------------+-----------------+-----------------------------------------+
+When a virtual environment is active, the :envvar:`VIRTUAL_ENV` environment
+variable is set to the path of the virtual environment. This can be used to
+check if one is running inside a virtual environment.
+
You don't specifically *need* to activate an environment; activation just
prepends the virtual environment's binary directory to your path, so that
"python" invokes the virtual environment's Python interpreter and you can run