Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pointed users to Python3.6 #3817

Merged
merged 1 commit into from May 24, 2018
Merged

Pointed users to Python3.6 #3817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 4 additions & 10 deletions docs/install.rst
View file
Open in desktop
Expand Up @@ -6,21 +6,15 @@ 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
First, obtain `Python 3.6`_ 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
clone the repository. If you plan to import Python 3 project to your RTD then you'll
need to install Python 3 with virtualenv in your system as well.
clone the repository. If you plan to import Python 2.7 project to your RTD then you'll
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can just drop this sentence. Python 2 will stay installed on most systems if I remember correctly. There is a proposal to link python to python3 or python3.X on some systems, but I doubt that will be accepted by Guido or other Python core developers.

need to install Python 2.7 with virtualenv in your system as well.


.. _Python 2.7: http://www.python.org/
.. _Python 3.6: http://www.python.org/
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _Git: http://git-scm.com/
.. _Homebrew: http://brew.sh/
Expand Down