##// END OF EJS Templates
Add warning on documentation for stop of python 2 support.
Matthias Bussonnier -
Show More
@@ -83,6 +83,8 b" templates_path = ['_templates']"
83 # The suffix of source filenames.
83 # The suffix of source filenames.
84 source_suffix = '.rst'
84 source_suffix = '.rst'
85
85
86 rst_prolog = ''
87
86 def is_stable(extra):
88 def is_stable(extra):
87 for ext in {'dev', 'b', 'rc'}:
89 for ext in {'dev', 'b', 'rc'}:
88 if ext in extra:
90 if ext in extra:
@@ -93,13 +95,22 b" if is_stable(iprelease['_version_extra']):"
93 tags.add('ipystable')
95 tags.add('ipystable')
94 else:
96 else:
95 tags.add('ipydev')
97 tags.add('ipydev')
96 rst_prolog = """
98 rst_prolog += """
97 .. warning::
99 .. warning::
100
101 This documentation is for a development version of IPython. There may be
102 significant differences from the latest stable release.
103 """
104
105 rst_prolog += """
106 .. important::
98
107
99 This documentation is for a development version of IPython. There may be
108 This is the documentation for IPython version > 6.0 which is had
100 significant differences from the latest stable release.
109 stopped compatibility for python version lower than 3.3. If you are
110 looking for a version of IPython compatible with python 2.7 please see
111 the documentation for the IPython 5.x LTS (Long term support branch)
101
112
102 """
113 """
103
114
104 # The master toctree document.
115 # The master toctree document.
105 master_doc = 'index'
116 master_doc = 'index'
@@ -170,6 +170,12 b' Get a fresh clone of the tag for building the release::'
170 8. Run the release script
170 8. Run the release script
171 -------------------------
171 -------------------------
172
172
173 .. important::
174
175 Following releases instructions have information to release IPython 5.x and
176 6.x both on python 2 and python 3. When reasing IPython 6+, ignore the step
177 for python2.
178
173 Run the ``release`` script, this step requires having a current wheel, Python
179 Run the ``release`` script, this step requires having a current wheel, Python
174 >=3.4 and Python 2.7.::
180 >=3.4 and Python 2.7.::
175
181
@@ -189,7 +195,7 b' It should posts them to ``archive.ipython.org``.'
189
195
190 You will need to use `twine <https://github.com/pypa/twine>`_ ) manually to
196 You will need to use `twine <https://github.com/pypa/twine>`_ ) manually to
191 actually upload on PyPI. Unlike setuptools, twine is able to upload packages
197 actually upload on PyPI. Unlike setuptools, twine is able to upload packages
192 over SSL.
198 over SSL::
193
199
194 twine upload dist/*
200 twine upload dist/*
195
201
@@ -239,7 +239,8 b' This functionality is optional and now part of the `ipyparallel'
239 Portability and Python requirements
239 Portability and Python requirements
240 -----------------------------------
240 -----------------------------------
241
241
242 As of the 2.0 release, IPython works with Python 2.7 and 3.3 or above.
242 Version 6.0 of IPython work with python 3.3 and above.
243 Version 2.0 to 5 works with Python 2.7 and 3.3 or above.
243 Version 1.0 additionally worked with Python 2.6 and 3.2.
244 Version 1.0 additionally worked with Python 2.6 and 3.2.
244 Version 0.12 was the first version to fully support Python 3.
245 Version 0.12 was the first version to fully support Python 3.
245
246
General Comments 0
You need to be logged in to leave comments. Login now