From ce6f85087dfcec594ee4a289dc83a07a7c4c02aa Mon Sep 17 00:00:00 2001 From: Hizkia Felix Date: Fri, 6 Apr 2018 21:29:22 +0700 Subject: [PATCH] README.rst: Update build instructions This adds virtualenv to the build procedure to make sure that the documentation gets built with the correct python version. Closes https://github.com/coala/documentation/issues/514 --- README.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e256f199..9de98597 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,20 @@ The coala repository can be found How to build ============ -You should run this command before trying to build the documentation: +Install ``virtualenv`` if you don't have it yet: + +:: + + pip3 install virtualenvwrapper + +Create a new ``virtualenv`` and activate it: + +:: + + virtualenv -p python3 coala-venv + source coala-venv/bin/activate + +And then run this command before trying to build the documentation: ::