From 6fefb8a0c97b67abd03206c3b03ccb8c672b81ff Mon Sep 17 00:00:00 2001 From: heck Date: Fri, 6 Nov 2020 13:45:22 +0100 Subject: [PATCH] typos etc.. --- README.rst | 2 +- docs/source/install.rst | 32 +++++++++++++++++--------------- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index e7186be..ee26c8c 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ pEpPythonAdapter ================ -Python adapter for the [pEpEngine](https://pep.foundation/dev/repos/pEpEngine/) +Python adapter for the `pEpEngine `_ Documentation diff --git a/docs/source/install.rst b/docs/source/install.rst index 8c4a45b..b3696d0 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -14,7 +14,7 @@ These `build instructions `_ that executes these build instructions automatically (Debian and MacOS): -.. Note:: If you dont install pEp-base system wide, but under a prefix, like /home/foo/local/ +.. Note:: If you dont install pEp-base system wide, but under a prefix, like /home/foo/local/, you will need to have LD_LIBARY_PATH/DYLD_LIBRARY_PATH adjusted for all the following operations. @@ -42,25 +42,13 @@ To build the module just type: This will compile the C/C++ parts of the module and create the python packages in the .egg and .wheel format in the dist/ dir. -Installation ------------- -You can install the module in the in the following ways: - -To install the extension module system wide or into a venv: - -``make install`` - -To install the extension module into you home dir: - -``make install-user`` - Virtualenv ---------- We recommend using a venv to work on/with the pEpPythonAdapter. There is a convenience make target that will create and activate a venv that already has the LD_LIBRARY_PATH -or DYLD_LIBRARY_PATH set according to your ```local.conf``. -If the venv is not existing yet it will be created and activated. +or DYLD_LIBRARY_PATH set according to your ``local.conf``. +If the venv does not yet it will be created and activated. If the venv already exists it will only be activated. ``make venv`` @@ -69,6 +57,20 @@ After that, to install the pEp module into the venv, do: ``make install`` + +Installation +------------ +You can install the module in the in the following ways. + +To install the extension module system wide or into a venv, use: + +``make install`` + +To install the extension module into your home dir, use: + +``make install-user`` + + Test ---- To run the whole testsuite you need to create/activate the venv, and then invoke the make target 'test'.