From 5a3c73610fba4fbcecad98f97d8149bb55cac3c0 Mon Sep 17 00:00:00 2001 From: Gerry Manoim Date: Thu, 16 Jul 2020 13:51:08 -0400 Subject: [PATCH 1/3] DOC: Add notes on install instructions --- README.rst | 6 ++++++ docs/source/install.rst | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/README.rst b/README.rst index 93a1ae06..fcbd4c7d 100644 --- a/README.rst +++ b/README.rst @@ -47,6 +47,12 @@ To install for development: Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler. +**Note**: The installation of ``libpy`` will use the ``python`` executable to + figure out information about your environment. If you are not using a virtual + environment or ``python`` does not point to the Python installation you want + to use (checked with ``which python`` and ``python --version``) you must + point to your Python exacutable using the ``PYTHON`` environment variable, + i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``. Tests ----- diff --git a/docs/source/install.rst b/docs/source/install.rst index 78ae57b6..243e9e15 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -32,6 +32,13 @@ To install for development: Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler. +.. note:: + The installation of ``libpy`` will use the ``python`` executable to + figure out information about your environment. If you are not using a virtual + environment or ``python`` does not point to the Python installation you want + to use (checked with ``which python`` and ``python --version``) you must + point to your Python exacutable using the ``PYTHON`` environment variable, + i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``. Tests ----- From 4ca41217bb51be319f1d957e69f116872905d101 Mon Sep 17 00:00:00 2001 From: Gerry Manoim Date: Thu, 16 Jul 2020 13:55:07 -0400 Subject: [PATCH 2/3] fix syntax --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index fcbd4c7d..92132356 100644 --- a/README.rst +++ b/README.rst @@ -48,11 +48,11 @@ To install for development: Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler. **Note**: The installation of ``libpy`` will use the ``python`` executable to - figure out information about your environment. If you are not using a virtual - environment or ``python`` does not point to the Python installation you want - to use (checked with ``which python`` and ``python --version``) you must - point to your Python exacutable using the ``PYTHON`` environment variable, - i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``. +figure out information about your environment. If you are not using a virtual +environment or ``python`` does not point to the Python installation you want +to use (checked with ``which python`` and ``python --version``) you must +point to your Python exacutable using the ``PYTHON`` environment variable, +i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``. Tests ----- From 0f867dee31e41269b65ba1d4228bbf5cc913800b Mon Sep 17 00:00:00 2001 From: Gerry Manoim Date: Thu, 16 Jul 2020 14:41:02 -0400 Subject: [PATCH 3/3] spelling - my greatest nemesis --- README.rst | 2 +- docs/source/install.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 92132356..b1427c55 100644 --- a/README.rst +++ b/README.rst @@ -51,7 +51,7 @@ Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment var figure out information about your environment. If you are not using a virtual environment or ``python`` does not point to the Python installation you want to use (checked with ``which python`` and ``python --version``) you must -point to your Python exacutable using the ``PYTHON`` environment variable, +point to your Python executable using the ``PYTHON`` environment variable, i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``. Tests diff --git a/docs/source/install.rst b/docs/source/install.rst index 243e9e15..13cce2c8 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -37,7 +37,7 @@ Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment var figure out information about your environment. If you are not using a virtual environment or ``python`` does not point to the Python installation you want to use (checked with ``which python`` and ``python --version``) you must - point to your Python exacutable using the ``PYTHON`` environment variable, + point to your Python executable using the ``PYTHON`` environment variable, i.e. ``PYTHON=python3 make`` or ``PYTHON=python3 pip3 install libpy``. Tests