Skip to content

Commit 055a1ac

Browse files
authored
Update docs on python version (#2643)
* Update docs on python version Adds info for new build images. * Bump docker version
1 parent a534402 commit 055a1ac

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/yaml-config.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,27 @@ used for building documentation.
7878
python.version
7979
``````````````
8080

81-
* Default: ``2``
82-
* Options: ``2``, ``3``
81+
* Default: ``2.7``
82+
* Options: ``2.7``, ``2``, ``3.5``, ``3``
8383

84-
The version of Python to use when building your documentation.
84+
This is the version of Python to use when building your documentation. If you
85+
specify only the major version of Python, the highest supported minor version
86+
will be selected.
87+
88+
The supported Python versions depends on the version of the build image your
89+
project is using. The default build image that is used to build documentation
90+
contains support for Python ``2.7`` and ``3.5``.
91+
92+
There is also an image in testing that supports Python versions ``2.7``,
93+
``3.3``, ``3.4``, ``3.5``, and ``3.6``. If you would like access to this build
94+
image, you can sign up for beta access here:
95+
96+
https://goo.gl/forms/AKEoeWHixlzVfqKT://goo.gl/forms/AKEoeWHixlzVfqKT2
8597

8698
.. code-block:: yaml
8799
88-
python:
89-
version: 3
100+
python:
101+
version: 3.5
90102
91103
python.setup_py_install
92104
```````````````````````

readthedocs/settings/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ def INSTALLED_APPS(self): # noqa
240240

241241
# Docker
242242
DOCKER_ENABLE = False
243-
DOCKER_IMAGE = 'readthedocs/build:1.0'
243+
DOCKER_IMAGE = 'readthedocs/build:2.0'
244244

245245
# All auth
246246
ACCOUNT_ADAPTER = 'readthedocs.core.adapters.AccountAdapter'

0 commit comments

Comments
 (0)