##// END OF EJS Templates
Merge pull request #9907 from Carreau/docs-py-2...
Min RK -
r22861:f9c232f9 merge
parent child Browse files
Show More
@@ -83,6 +83,8 b" templates_path = ['_templates']"
83 83 # The suffix of source filenames.
84 84 source_suffix = '.rst'
85 85
86 rst_prolog = ''
87
86 88 def is_stable(extra):
87 89 for ext in {'dev', 'b', 'rc'}:
88 90 if ext in extra:
@@ -93,13 +95,25 b" if is_stable(iprelease['_version_extra']):"
93 95 tags.add('ipystable')
94 96 else:
95 97 tags.add('ipydev')
96 rst_prolog = """
97 .. warning::
98 rst_prolog += """
99 .. warning::
100
101 This documentation covers a development version of IPython. The development
102 version may differ significantly from the latest stable release.
103 """
104
105 rst_prolog += """
106 .. important::
107
108 This documentation covers IPython versions 6.0 and higher. Beginning with
109 version 6.0, IPython stopped supporting compatibility with Python versions
110 lower than 3.3 including all versions of Python 2.7.
98 111
99 This documentation is for a development version of IPython. There may be
100 significant differences from the latest stable release.
112 If you are looking for an IPython version compatible with Python 2.7,
113 please use the IPython 5.x LTS release and refer to its documentation (LTS
114 is the long term support release).
101 115
102 """
116 """
103 117
104 118 # The master toctree document.
105 119 master_doc = 'index'
@@ -170,6 +170,12 b' Get a fresh clone of the tag for building the release::'
170 170 8. Run the release script
171 171 -------------------------
172 172
173 .. important::
174
175 These steps cover instructions for creating releases of IPython 5.x LTS and
176 IPython 6.x. Ignore release steps for Python 2 when releasing IPython 6.x
177 which no longer supports Python 2.
178
173 179 Run the ``release`` script, this step requires having a current wheel, Python
174 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 196 You will need to use `twine <https://github.com/pypa/twine>`_ ) manually to
191 197 actually upload on PyPI. Unlike setuptools, twine is able to upload packages
192 over SSL.
198 over SSL::
193 199
194 200 twine upload dist/*
195 201
@@ -239,7 +239,8 b' This functionality is optional and now part of the `ipyparallel'
239 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+ supports compatibility with Python 3.3 and higher.
243 Versions 2.0 to 5.x work with Python 2.7.x releases and Python 3.3 and higher.
243 244 Version 1.0 additionally worked with Python 2.6 and 3.2.
244 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