diff --git a/docs/source/conf.py b/docs/source/conf.py index 1fbf960..eda465c 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,22 @@ if is_stable(iprelease['_version_extra']): tags.add('ipystable') else: tags.add('ipydev') - rst_prolog = """ - .. warning:: + rst_prolog += """ +.. warning:: + + This documentation is for a development version of IPython. There may be + significant differences from the latest stable release. +""" + +rst_prolog += """ +.. important:: - This documentation is for a development version of IPython. There may be - significant differences from the latest stable release. + This is the documentation for IPython version > 6.0 which is had + stopped compatibility for python version lower than 3.3. If you are + looking for a version of IPython compatible with python 2.7 please see + the documentation for the IPython 5.x LTS (Long term support branch) - """ +""" # The master toctree document. master_doc = 'index' diff --git a/docs/source/coredev/release_process.rst b/docs/source/coredev/release_process.rst index 16b8e6a..dda8299 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:: + + Following releases instructions have information to release IPython 5.x and + 6.x both on python 2 and python 3. When reasing IPython 6+, ignore the step + for python2. + 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..65eb60c 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 of IPython work with python 3.3 and above. +Version 2.0 to 5 works with Python 2.7 and 3.3 or above. Version 1.0 additionally worked with Python 2.6 and 3.2. Version 0.12 was the first version to fully support Python 3.