From d547f8ac1748fb0d82aec288a335f79739e2dc4d Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Thu, 15 Feb 2018 00:11:55 -0500 Subject: [PATCH 1/2] Add note about virtualenv --- docs/install.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/install.rst b/docs/install.rst index 242b884d51e..de9e35172bd 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -104,6 +104,19 @@ Next, install the dependencies using ``pip`` (included inside of virtualenv_):: cd readthedocs.org pip install -r requirements.txt +.. note:: + + Make sure you are running the ``python`` command from your virtualenv, + no the one from your system on the next steps. + An easy way to check this is by running the following command on your terminal:: + + python -c "import sys; print('\n'.join(sys.path))" + + If in the output there isn't a path to your virtualenv, + you may check if the virtualenv is activated, + or try with ``python2`` or ``python3`` command respectively. + + This may take a while, so go grab a beverage. When it's done, build your database:: From c3ff7bdc540057cd395779de104c441537c88d00 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Thu, 15 Feb 2018 00:12:27 -0500 Subject: [PATCH 2/2] Explicit local_settings.py path --- docs/install.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index de9e35172bd..8bb3a0e3300 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -150,8 +150,9 @@ superuser account you just created). For builds to properly kick off as expected, it is necessary the port you're serving on (i.e. ``runserver 0.0.0.0:8080``) match the port defined -in ``PRODUCTION_DOMAIN``. You can utilize ``local_settings.py`` to modify this. -(By default, it's ``localhost:8000``) +in ``PRODUCTION_DOMAIN``. +You can utilize ``readthedocs/settings/local_settings.py`` to modify this +(by default, it's ``localhost:8000``). While the webserver is running, you can build documentation for the latest version of a project called 'pip' with the ``update_repos`` command. You can replace 'pip'