Add virtual env instructions to local installation
@@ -22,33 +22,37 @@ you can verify those changes through the documentation generated when you open a
Contributing from your local machine
------------------------------------
-.. note::
-
- You must use python 3.6 to generate the documentation.
-
If you're making large changes to the documentation,
you may want to verify those changes locally before pushing upstream.
#. clone the `readthedocs.org` repository:
- .. prompt:: bash
+ .. code-block:: bash
+
+ $ git clone --recurse-submodules https://github.com/readthedocs/readthedocs.org/
+
+#. create a virtual environment with Python 3.6 and activate it:
+
+ .. code-block:: bash
- git clone --recurse-submodules https://github.com/readthedocs/readthedocs.org/
+ $ cd readthedocs.org
+ $ python3.6 -m venv .venv
+ $ source .venv/bin/activate
+ (.venv) $
#. install documentation requirements
- .. prompt:: bash
+ .. code-block:: bash
- cd readthedocs.org
- pip install -r requirements/testing.txt
- pip install -r requirements/docs.txt
+ (.venv) $ pip install -r requirements/testing.txt
+ (.venv) $ pip install -r requirements/docs.txt
#. build the documents
- .. prompt:: bash
+ .. code-block:: bash
- cd docs
- make livehtml
+ (.venv) $ cd docs
+ (.venv) $ make livehtml
#. the documents will be available at http://127.0.0.1:4444/ and will rebuild each time you edit and save a file.
