From a0a19dd0b38dc713d581f1c8f2767ac269aab62f Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Mon, 24 Feb 2020 13:42:07 +0100 Subject: [PATCH] Add basic README for documentation Signed-off-by: Robert Winkler --- README.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..f0c4a2b --- /dev/null +++ b/README.rst @@ -0,0 +1,30 @@ +=============== +Getting Started +=============== + +Building documentation +---------------------- + +Activate the virtual environment and install dependencies:: + + make env + source enter-env.sh + +Build the whole documentation:: + + make html + +For more options see:: + + make help + +Packages in virtual environment +------------------------------- + +To install packages in conda environment you can use both +``conda`` and ``pip``. + +Note that ``pip`` is installed in the conda environment which uses ``python3``, +and is related to ``pip3`` **inside** the virtual environment, +whereas invocation of ``pip3`` directly uses your **system** ``pip3`` instance, +typically located in ``/usr/bin/pip3``