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.

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

Post on defaulting to Python 3 #57

Merged
merged 4 commits into from
Feb 12, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions default-python-3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. post:: Feb 12, 2019
:author: Anthony
:tags: python

agjohnson marked this conversation as resolved.
Show resolved Hide resolved
Defaulting New Projects to Python 3
===================================

New projects that are just getting started with Read the Docs will now use
Python 3 by default. While it is still possible to configure your project to use
Python 2.7 with :doc:`our configuration file <readthedocs:config-file/v2>`, we
think it's important to help push the Python ecosystem towards adopting Python 3.

Our default Python version is currently Python 3.7. Projects can also select
Python versions 3.6 and 3.5 using our default build image. We will eventually
remove support for building projects with Python versions 3.3 and 3.4, however
it is still possible to select a build image with support for either version.

To select a specific version of Python, other than our default, you can use our
configuration file to specify a Python version, using the
:ref:`readthedocs:config-file/v2:python.version` configuration option.

If your project does require Python version 3.3 or 3.4, you can only select
these versions if you also specify ``stable`` build image for your project's
:ref:`readthedocs:config-file/v2:build.image` configuration option. As we
release new versions of our build image, this ``stable`` image will eventually
lose support for Python 3.3 and 3.4, so it's suggested that your project upgrade
to a supported version of Python.