EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add warning to use Python 2.7 in install docs (#2866) 

(closes #2865)
gthank-master
Daniel Pope 2017-05-22 12:00:51 -07:00 committed by Anthony
parent 96042fd94a
commit 1a08ad7ba7
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/install.rst
View File

@ -6,6 +6,13 @@ Installation
Here is a step by step plan on how to install Read the Docs.
It will get you to a point of having a local running instance.
.. warning::
Read the Docs does not itself run under Python 3 (though it does support
building documentation for Python 3 projects). Please ensure the subsequent
steps are performed using Python 2.7.
First, obtain `Python 2.7`_ and virtualenv_ if you do not already have them. Using a
virtual environment will make the installation easier, and will help to avoid
clutter in your system-wide libraries. You will also need Git_ in order to