|
| 1 | +.. post:: Mar 29, 2018 |
| 2 | + :author: Anthony |
| 3 | + |
| 4 | +Python 3.6 Support |
| 5 | +================== |
| 6 | + |
| 7 | +A long time back, :doc:`we wrote about </build-image-upgrade>` started testing |
| 8 | +a new build image that uses `pyenv`_ to support multiple versions of Python. |
| 9 | +Until recently, we were selectively opting projects in to help test the new |
| 10 | +image, but at the beginning of the year, we added a configuration option to |
| 11 | +allow projects to opt in to using the new image before we make it the default |
| 12 | +build image. |
| 13 | + |
| 14 | +In the near future, this build image will be the default build image, but for |
| 15 | +now, you can manually opt your project in using our |
| 16 | +:doc:`YAML configuration file <readthedocs:yaml-config>`. |
| 17 | + |
| 18 | +What you need |
| 19 | +------------- |
| 20 | + |
| 21 | +In order to use Python 3.6, you need to select our ``latest`` build image, and |
| 22 | +you need to select to use Python 3.6. The build image is controlled with the |
| 23 | +:ref:`readthedocs:yaml__build__image` setting in the YAML config, and you can |
| 24 | +set the Python version with the :ref:`readthedocs:yaml__python__version` |
| 25 | +setting. |
| 26 | + |
| 27 | +Your project's ``readthedocs.yml`` file should contain:: |
| 28 | + |
| 29 | + build: |
| 30 | + image: latest |
| 31 | + |
| 32 | + python: |
| 33 | + version: 3.6 |
| 34 | + |
| 35 | +If you run in to any problems building, you might also need to wipe your version |
| 36 | +for now. We plan to have some of the issues switching Python versions and build |
| 37 | +images resolved before making a move to a new build image. |
| 38 | + |
| 39 | +As always, if you notice anything strange with your build, feel free to raise an |
| 40 | +issue on `our issue tracker`_. |
| 41 | + |
| 42 | +.. _pyenv: https://github.com/yyuu/pyenv |
| 43 | +.. _our issue tracker: https://github.com/rtfd/readthedocs.org/issues |
0 commit comments