From 6463bcd7020a6c59a1d25e79bc62b2ecf8105d42 Mon Sep 17 00:00:00 2001 From: Micah Smith Date: Tue, 1 Nov 2022 22:34:55 -0400 Subject: [PATCH] Update docs --- docs/advanced.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index a6cf001c..2714c60c 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -628,11 +628,17 @@ You can display the names and commands of your shortcuts by running ``pipenv scr ☤ Configuration With Environment Variables ------------------------------------------ -Pipenv comes with a handful of options that can be enabled via shell environment -variables. To activate them, simply create the variable in your shell and pipenv -will detect it. +Pipenv comes with a handful of options that can be set via shell environment +variables. -.. automodule:: pipenv.environments +To enable boolean options, create the variable in your shell and assign to it a +truthy value (i.e. ``"1"``):: + + $ PIPENV_IGNORE_VIRTUALENVS=1 + +To explicitly disable a boolean option, assign to it a falsy value (i.e. ``"0"``). + +.. autoclass:: pipenv.environments.Setting :members: If you'd like to set these environment variables on a per-project basis, I recommend utilizing the fantastic `direnv `_ project, in order to do so.