Skip to content

Commit ca483e0

Browse files
author
gerrymanoim
authored
DOC: Add more documentation on choosing a python on install (#196)
* DOC: Add notes on install instructions
1 parent e509a10 commit ca483e0

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ To install for development:
4747
4848
Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler.
4949

50+
**Note**: The installation of ``libpy`` will use the ``python`` executable to
51+
figure out information about your environment. If you are not using a virtual
52+
environment or ``python`` does not point to the Python installation you want
53+
to use (checked with ``which python`` and ``python --version``) you must
54+
point to your Python executable using the ``PYTHON`` environment variable,
55+
i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``.
5056

5157
Tests
5258
-----

docs/source/install.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ To install for development:
3232
3333
Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler.
3434

35+
.. note::
36+
The installation of ``libpy`` will use the ``python`` executable to
37+
figure out information about your environment. If you are not using a virtual
38+
environment or ``python`` does not point to the Python installation you want
39+
to use (checked with ``which python`` and ``python --version``) you must
40+
point to your Python executable using the ``PYTHON`` environment variable,
41+
i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``.
3542

3643
Tests
3744
-----

0 commit comments

Comments
 (0)