From f9c232f96f9c3531df803754a17549b4c5cfdbfc 2016-09-12 09:43:10 From: Min RK Date: 2016-09-12 09:43:10 Subject: [PATCH] Merge pull request #9907 from Carreau/docs-py-2 Add warning on documentation for stop of python 2 support. --- diff --git a/docs/source/conf.py b/docs/source/conf.py index 1fbf960..33440a2 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -83,6 +83,8 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' +rst_prolog = '' + def is_stable(extra): for ext in {'dev', 'b', 'rc'}: if ext in extra: @@ -93,13 +95,25 @@ if is_stable(iprelease['_version_extra']): tags.add('ipystable') else: tags.add('ipydev') - rst_prolog = """ - .. warning:: + rst_prolog += """ +.. warning:: + + This documentation covers a development version of IPython. The development + version may differ significantly from the latest stable release. +""" + +rst_prolog += """ +.. important:: + + This documentation covers IPython versions 6.0 and higher. Beginning with + version 6.0, IPython stopped supporting compatibility with Python versions + lower than 3.3 including all versions of Python 2.7. - This documentation is for a development version of IPython. There may be - significant differences from the latest stable release. + If you are looking for an IPython version compatible with Python 2.7, + please use the IPython 5.x LTS release and refer to its documentation (LTS + is the long term support release). - """ +""" # The master toctree document. master_doc = 'index' diff --git a/docs/source/coredev/release_process.rst b/docs/source/coredev/release_process.rst index cf9a28c..63d6b79 100644 --- a/docs/source/coredev/release_process.rst +++ b/docs/source/coredev/release_process.rst @@ -170,6 +170,12 @@ Get a fresh clone of the tag for building the release:: 8. Run the release script ------------------------- +.. important:: + + These steps cover instructions for creating releases of IPython 5.x LTS and + IPython 6.x. Ignore release steps for Python 2 when releasing IPython 6.x + which no longer supports Python 2. + Run the ``release`` script, this step requires having a current wheel, Python >=3.4 and Python 2.7.:: @@ -189,7 +195,7 @@ It should posts them to ``archive.ipython.org``. You will need to use `twine `_ ) manually to actually upload on PyPI. Unlike setuptools, twine is able to upload packages -over SSL. +over SSL:: twine upload dist/* diff --git a/docs/source/overview.rst b/docs/source/overview.rst index ff39e16..b3a4aab 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -239,7 +239,8 @@ This functionality is optional and now part of the `ipyparallel Portability and Python requirements ----------------------------------- -As of the 2.0 release, IPython works with Python 2.7 and 3.3 or above. +Version 6.0+ supports compatibility with Python 3.3 and higher. +Versions 2.0 to 5.x work with Python 2.7.x releases and Python 3.3 and higher. Version 1.0 additionally worked with Python 2.6 and 3.2. Version 0.12 was the first version to fully support Python 3.