Skip to content

Commit

Permalink
Update pyenv docs to avoid using shim
Browse files Browse the repository at this point in the history
Also removed the PIPENV_PYTHON suggestion, as this is likely to cause
confusion if added to e.g. .bashrc - it will always be set to the
global pyenv.

Fixes #4534
  • Loading branch information
stevecshanks committed Nov 13, 2020
1 parent 35a8028 commit d38e666
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
11 changes: 3 additions & 8 deletions docs/diagnose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,9 @@ distributions, with version name like ``3.6.4`` or similar.
------------------------------------------------------------------

Pipenv by default uses the Python it is installed against to create the
virtualenv. You can set the ``--python`` option, or
``$PYENV_ROOT/shims/python`` to let it consult pyenv when choosing the
interpreter. See :ref:`specifying_versions` for more information.

If you want Pipenv to automatically “do the right thing”, you can set the
environment variable ``PIPENV_PYTHON`` to ``$PYENV_ROOT/shims/python``. This
will make Pipenv use pyenv’s active Python version to create virtual
environments by default.
virtualenv. You can set the ``--python`` option to ``$(pyenv which python)``
to use your current pyenv interpreter. See :ref:`specifying_versions` for more
information.

.. _unknown-local-diagnose:

Expand Down
1 change: 1 addition & 0 deletions news/4534.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix suggested pyenv setup to avoid using shimmed interpreter

0 comments on commit d38e666

Please sign in to comment.