Skip to content

Commit

Permalink
README.rst: Update build instructions
Browse files Browse the repository at this point in the history
This adds virtualenv to the build procedure to make sure that the
documentation gets built with the correct python version.

Closes coala#514
  • Loading branch information
hizkifw committed Apr 6, 2018
1 parent a01938b commit ce6f850
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

::

Expand Down

0 comments on commit ce6f850

Please sign in to comment.