Start to updates the what's new / changelog.

Also improve the documentation process to auto-list all the files in
docs/source/wn/pr with daily readthedocs builds

docs/source/conf.py

@@ -1,299 +1,298 b''
 # -*- coding: utf-8 -*-
 #
 # IPython documentation build configuration file.
 
 # NOTE: This file has been edited manually from the auto-generated one from
 # sphinx.  Do NOT delete and re-generate.  If any changes from sphinx are
 # needed, generate a scratch one and merge by hand any new fields needed.
 
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
 # The contents of this file are pickled, so don't put values in the namespace
 # that aren't pickleable (module imports are okay, they're removed automatically).
 #
 # All configuration values have a default value; values that are commented out
 # serve to show the default value.
 
 import sys, os
 
 # http://read-the-docs.readthedocs.io/en/latest/faq.html
 ON_RTD = os.environ.get('READTHEDOCS', None) == 'True'
 
 if ON_RTD:
     tags.add('rtd')
 
     # RTD doesn't use the Makefile, so re-run autogen_{things}.py here.
     for name in ('config', 'api', 'magics', 'shortcuts'):
         fname = 'autogen_{}.py'.format(name)
         fpath = os.path.abspath(os.path.join('..', fname))
         with open(fpath) as f:
             exec(compile(f.read(), fname, 'exec'), {
                 '__file__': fpath,
                 '__name__': '__main__',
             })
 else:
     import sphinx_rtd_theme
     html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../sphinxext'))
 
 # We load the ipython release info into a dict by explicit execution
 iprelease = {}
 exec(compile(open('../../IPython/core/release.py').read(), '../../IPython/core/release.py', 'exec'),iprelease)
 
 # General configuration
 # ---------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
     'sphinx.ext.graphviz',
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
     'sphinx.ext.napoleon',  # to preprocess docstrings
     'github',  # for easy GitHub links
     'magics',
     'configtraits',
 ]
 
 if ON_RTD:
     # Remove extensions not currently supported on RTD
     extensions.remove('IPython.sphinxext.ipython_directive')
     extensions.remove('IPython.sphinxext.ipython_console_highlighting')
 
 # Add any paths that contain templates here, relative to this directory.
 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:
             return False
     return True
 
 if is_stable(iprelease['_version_extra']):
     tags.add('ipystable')
 else:
     tags.add('ipydev')
     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.
 
     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'
 
 # General substitutions.
 project = 'IPython'
 copyright = 'The IPython Development Team'
 
 # ghissue config
 github_project_url = "https://github.com/ipython/ipython"
 
 # numpydoc config
 numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings
 numpydoc_class_members_toctree = False
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
 # The full version, including alpha/beta/rc tags.
 release = "%s" % iprelease['version']
 # Just the X.Y.Z part, no '-dev'
 version = iprelease['version'].split('-', 1)[0]
 
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
 today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
 
 # Exclude these glob-style patterns when looking for source files. They are
 # relative to the source/ directory.
-exclude_patterns = ['whatsnew/pr/antigravity-feature.*', 
-                    'whatsnew/pr/incompat-switching-to-perl.*']
+exclude_patterns = []
 
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 #add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # Set the default role so we can use `foo` instead of ``foo``
 default_role = 'literal'
 
 # Options for HTML output
 # -----------------------
 
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
 # html_style = 'default.css'
 
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 #html_title = None
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
 #html_logo = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
 # Favicon needs the directory name
 html_favicon = '_static/favicon.ico'
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 html_additional_pages = {
     'interactive/htmlnotebook': 'notebook_redirect.html',
     'interactive/notebook': 'notebook_redirect.html',
     'interactive/nbconvert': 'notebook_redirect.html',
     'interactive/public_server': 'notebook_redirect.html',
 }
 
 # If false, no module index is generated.
 #html_use_modindex = True
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
 #html_copy_source = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'ipythondoc'
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3/', None),
                        'rpy2': ('https://rpy2.readthedocs.io/en/version_2.8.x/', None),
                        'traitlets': ('https://traitlets.readthedocs.io/en/latest/', None),
                        'jupyterclient': ('https://jupyter-client.readthedocs.io/en/latest/', None),
                        'ipyparallel': ('https://ipyparallel.readthedocs.io/en/latest/', None),
                        'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None),
                        'jedi': ('https://jedi.readthedocs.io/en/latest/', None),
                        'traitlets': ('https://traitlets.readthedocs.io/en/latest/', None),
                        'ipykernel': ('https://ipykernel.readthedocs.io/en/latest/', None),
                        'prompt_toolkit' : ('https://python-prompt-toolkit.readthedocs.io/en/stable/', None),
                        'ipywidgets': ('https://ipywidgets.readthedocs.io/en/stable/', None),
                        'ipyparallel': ('https://ipyparallel.readthedocs.io/en/stable/', None)
                       }
 
 # Options for LaTeX output
 # ------------------------
 
 # The paper size ('letter' or 'a4').
 latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
 latex_font_size = '11pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 
 latex_documents = [
     ('index', 'ipython.tex', 'IPython Documentation',
      u"""The IPython Development Team""", 'manual', True),
     ('parallel/winhpc_index', 'winhpc_whitepaper.tex',
      'Using IPython on Windows HPC Server 2008',
      u"Brian E. Granger", 'manual', True)
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 #latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 #latex_use_parts = False
 
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
 
 # If false, no module index is generated.
 latex_use_modindex = True
 
 
 # Options for texinfo output
 # --------------------------
 
 texinfo_documents = [
   (master_doc, 'ipython', 'IPython Documentation',
    'The IPython Development Team',
    'IPython',
    'IPython Documentation',
    'Programming',
    1),
 ]
 
 modindex_common_prefix = ['IPython.']
 
 
 # Cleanup
 # -------
 # delete release info to avoid pickling errors from sphinx
 
 del iprelease

docs/source/whatsnew/development.rst

@@ -1,46 +1,32 b''
 =====================
  Development version
 =====================
 
 This document describes in-flight development work.
 
 .. warning::
 
     Please do not edit this file by hand (doing so will likely cause merge
     conflicts for other Pull Requests). Instead, create a new file in the
     `docs/source/whatsnew/pr` folder
 
 
 Released .... ...., 2017
 
 
 Need to be updated:
 
 .. toctree::
    :maxdepth: 2
-   :glob: 
+   :glob:
 
    pr/*
 
-IPython 6 feature a major improvement in the completion machinery which is now
-capable of completing non-executed code. It is also the first version of IPython
-to stop compatibility with Python 2, which is still supported on the bugfix only
-5.x branch. Read below to have a non-exhaustive list of new features.
-
-Make sure you have pip > 9.0 before upgrading. 
-You should be able to update by using:
-
-.. code::
-
-    pip install ipython --upgrade
-
-
-
 
 .. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT.
 
 
 Backwards incompatible changes
 ------------------------------
 
 .. DO NOT EDIT THIS LINE BEFORE RELEASE. INCOMPAT INSERTION POINT.

docs/source/whatsnew/index.rst

@@ -1,45 +1,46 b''
 .. Developers should add in this file, during each release cycle, information
 .. about important changes they've made, in a summary format that's meant for
 .. end users.  For each release we normally have three sections: features,  bug
 .. fixes and api breakage.
 .. Please remember to credit the authors of the contributions by name,
 .. especially when they are new users or developers who do not regularly
 .. participate  in IPython's development.
 
 .. _whatsnew_index:
 
 =====================
 What's new in IPython
 =====================
 
 This section documents the changes that have been made in various versions of
 IPython. Users should consult these pages to learn about new features, bug
 fixes and backwards incompatibilities. Developers should summarize the
 development work they do here in a user friendly format.
 
 .. toctree::
    :maxdepth: 1
 
    development
+   version7
    version6
    github-stats-6
    version5
    github-stats-5
    version4
    github-stats-4
    version3
    github-stats-3
    version3_widget_migration
    version2.0
    github-stats-2.0
    version1.0
    github-stats-1.0
    version0.13
    github-stats-0.13
    version0.12
    github-stats-0.12
    version0.11
    github-stats-0.11
    version0.10
    version0.9
    version0.8

docs/source/whatsnew/pr/antigravity-feature.rst

@@ -0,0 +1,5 b''
+Antigravity feature
+===================
+
+Example new antigravity feature. Try ``import antigravity`` in a Python 3
+console.

docs/source/whatsnew/pr/incompat-switching-to-perl.rst

@@ -0,0 +1,1 b''
+Starting with IPython 42, only perl code execution is allowed. See :ghpull:`42`

docs/source/whatsnew/version7.rst

@@ -1,99 +1,214 b''
+============
+ 7.x Series
+============
+
+.. _whatsnew700:
+
+IPython 7.0.0
+=============
+
+.. warning::
+
+   IPython 7.0 is currently in Beta, Feedback on API/changes and
+   addition/updates to this cahngelog are welcomed.
+
+Released .... ...., 2017
+
+IPython 7 include major features improvement as you can read in the following
+changelog. This is also the second major version of IPython to stop support only
+Python 3 – starting at Python 3.4. Python 2 is still still community supported
+on the bugfix only 5.x branch, but we remind you that Python 2 EOL is Jan 1st
+2020.
+
+We were able to backport bug fixes to the 5.x branch thanks to our backport bot which
+backported more than `70 Pull-Requests
+<https://github.com/ipython/ipython/pulls?page=3&q=is%3Apr+sort%3Aupdated-desc+author%3Aapp%2Fmeeseeksdev++5.x&utf8=%E2%9C%93>`_, but there are still many PRs that required manually work, and this is an area of the project were you can easily contribute by looking for `PRs still needed backport<https://github.com/ipython/ipython/issues?q=label%3A%22Still+Needs+Manual+Backport%22+is%3Aclosed+sort%3Aupdated-desc>`_
+
+IPython 6.x branch will likely not see any further release unless we critical
+bugs are found.
+
+Make sure you have pip > 9.0 before upgrading. You should be able to update by simply runngin
+
+.. code::
+
+    pip install ipython --upgrade
+
+Or if you have conda installed: 
+
+.. code::
+   
+   conda install ipython
+
+
+
+Prompt Toolkit 2.0
+------------------
+
+IPython 7.0+ now use ``prompt_toolkit 2.0``, if you still need to use earlier 
+``prompt_toolkit`` version you may need to pin IPython to ``<7.0``.
+
 Autowait: Asynchronous REPL
 ---------------------------
 
 Staring with IPython 7.0 and on Python 3.6+, IPython can automatically await
 code at top level, you should not need to access an event loop or runner
 yourself. To know more read the :ref:`autoawait` section of our docs, see
 :ghpull:`11265` or try the following code::
 
     Python 3.6.0
     Type 'copyright', 'credits' or 'license' for more information
     IPython 7.0.0 -- An enhanced Interactive Python. Type '?' for help.
 
     In [1]: import aiohttp
        ...: result = aiohttp.get('https://api.github.com')
 
     In [2]: response = await result
     <pause for a few 100s ms>
 
     In [3]: await response.json()
     Out[3]:
     {'authorizations_url': 'https://api.github.com/authorizations',
      'code_search_url': 'https://api.github.com/search/code?q={query}{&page,per_page,sort,order}',
     ...
     }
 
 .. note::
 
    Async integration is experimental code, behavior may change or be removed
    between Python and IPython versions without warnings.
 
-Integration is by default with `asyncio`, but other libraries can be configured, 
+Integration is by default with `asyncio`, but other libraries can be configured,
 like ``curio`` or ``trio``, to improve concurrency in the REPL::
 
     In [1]: %autoawait trio
 
     In [2]: import trio
 
     In [3]: async def child(i):
        ...:     print("   child %s goes to sleep"%i)
        ...:     await trio.sleep(2)
        ...:     print("   child %s wakes up"%i)
 
     In [4]: print('parent start')
        ...: async with trio.open_nursery() as n:
        ...:     for i in range(3):
        ...:         n.spawn(child, i)
        ...: print('parent end')
     parent start
        child 2 goes to sleep
        child 0 goes to sleep
        child 1 goes to sleep
        <about 2 seconds pause>
        child 2 wakes up
        child 1 wakes up
        child 0 wakes up
     parent end
 
 See :ref:`autoawait` for more information.
 
 
 Asynchronous code in a Notebook interface or any other frontend using the
 Jupyter Protocol will need further updates of the IPykernel package.
 
-Non-Asynchronous code 
----------------------
+Non-Asynchronous code
+~~~~~~~~~~~~~~~~~~~~~
 
 As the internal API of IPython are now asynchronous, IPython need to run under
 an even loop. In order to allow many workflow, (like using the ``%run`` magic,
 or copy_pasting code that explicitly starts/stop event loop), when top-level code
 is detected as not being asynchronous, IPython code is advanced via a
 pseudo-synchronous runner, and will not may not advance pending tasks.
 
 Change to Nested Embed
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 The introduction of the ability to run async code had some effect on the
 ``IPython.embed()`` API. By default embed will not allow you to run asynchronous
 code unless a event loop is specified.
 
 Effects on Magics
------------------
+~~~~~~~~~~~~~~~~~
 
 Some magics will not work with Async, and will need updates. Contribution
 welcome.
 
 Expected Future changes
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
 
 We expect more internal but public IPython function to become ``async``, and
 will likely end up having a persisting event loop while IPython is running.
 
 Thanks
-------
+~~~~~~
 
 This took more than a year in the making, and the code was rebased a number of
 time leading to commit authorship that may have been lost in the final
 Pull-Request. Huge thanks to many people for contribution, discussion, code,
 documentation, use-case: dalejung, danielballan, ellisonbg, fperez, gnestor,
 minrk, njsmith, pganssle, tacaswell, takluyver , vidartf ... And many other.
+
+
+Autoreload Improvment
+---------------------
+
+The magic ``%autoreload 2`` now captures new methods added to classes. Earlier, only methods existing as of the initial import were being tracked and updated.  
+
+This new feature helps dual environment development - Jupyter+IDE - where the code gradually moves from notebook cells to package files, as it gets structured.
+
+**Example**: An instance of the class `MyClass` will be able to access the method `cube()` after it is uncommented and the file `file1.py` saved on disk.
+
+
+..code::
+
+   # notebook
+
+   from mymodule import MyClass
+   first = MyClass(5)
+
+.. code::
+   # mymodule/file1.py
+
+   class MyClass:
+
+       def __init__(self, a=10):
+           self.a = a
+
+       def square(self):
+           print('compute square')
+           return self.a*self.a
+
+       # def cube(self):
+       #     print('compute cube')
+       #     return self.a*self.a*self.a
+
+
+
+
+Misc
+----
+
+The autoindent feature that was deprecated in 5.x was re-enabled and
+un-deprecated in :ghpull:`11257`
+
+Make ``%run -n -i ...`` work correctly. Earlier, if ``%run`` was passed both arguments, ``-n`` would be silently ignored. See :ghpull:`10308`
+
+
+
+
+
+Deprecations
+------------
+
+A couple of unused function and methods have been deprecated and will be removed
+in future versions:
+
+  - ``IPython.utils.io.raw_print_err``
+  - ``IPython.utils.io.raw_print``
+
+  
+Backwards incompatible changes
+------------------------------
+
+* The API for transforming input before it is parsed as Python code has been
+  completely redesigned, and any custom input transformations will need to be
+  rewritten. See :doc:`/config/inputtransforms` for details of the new API.

tools/fixup_whats_new_pr.py

@@ -1,43 +1,46 b''
 """
 This tool is used during CI testing to make sure sphinx raise no error.
 
 During development, we like to have whatsnew/pr/*.rst documents to track
 individual new features. Unfortunately they other either:
   - have no title (sphinx complains)
   - are not included in any toctree (sphinx complain)
 
 This fix-them up by "inventing" a title, before building the docs. At release
 time, these title and files will anyway be rewritten into the actual release
 notes.
 """
 
 import glob
 
 
 def main():
     folder = 'docs/source/whatsnew/pr/'
     assert folder.endswith('/')
     files = glob.glob(folder+'*.rst')
     print(files)
 
     for filename in files:
         print('Adding pseudo-title to:', filename)
         title = filename[:-4].split('/')[-1].replace('-', ' ').capitalize()
 
         with open(filename) as f:
             data = f.read()
-        if data and data.splitlines()[1].startswith('='):
-            continue
+        try:
+            if data and data.splitlines()[1].startswith('='):
+                continue
+        except IndexError:
+            pass
 
         with open(filename, 'w') as f:
             f.write(title+'\n')
             f.write('='* len(title)+'\n\n')
             f.write(data)
 
 if __name__ == '__main__':
     main()