Remove some manual manipulation of whatsnew when releasing.

anntzer · anntzer · commit bc58b921593a · 2018-03-21T13:41:26.000-07:00
This PR ensures that the "unmerged" whatsnew entries get included in the
docs if and only if we're building the docs for a "local release", i.e.
when the version number includes a git tag, but not a tagged release.
This previously required manual manipulation.
diff --git a/doc/conf.py b/doc/conf.py
@@ -31,6 +31,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
+    'sphinx.ext.ifconfig',
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
     'IPython.sphinxext.ipython_console_highlighting',
diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst
@@ -48,10 +48,10 @@ Review and commit changes.  Some issue/PR titles may not be valid rst (the most
 Check Docs
 ----------
 
-Before tagging, update the what's new listing in :file:`doc/users/whats_new.rst`
-by merging all files in :file:`doc/users/next_whats_new/` coherently. Also,
-temporarily comment out the include and toctree glob; re-instate these after a
-release. Finally, make sure that the docs build cleanly ::
+Before tagging, update the what's new listing in
+:file:`doc/users/whats_new.rst` by merging all files in
+:file:`doc/users/next_whats_new/` coherently.  Then, make sure that the docs
+build cleanly::
 
   make -Cdoc O=-n$(nproc) html latexpdf
 
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -10,16 +10,14 @@ revision, see the :ref:`github-stats`.
 .. contents:: Table of Contents
    :depth: 4
 
+.. ifconfig:: __import__('pkg_resources').parse_version(version).local
 
-..
-   For a release, add a new section after this, then comment out the include
-   and toctree below by indenting them. Uncomment them after the release.
-.. include:: next_whats_new/README.rst
-.. toctree::
-   :glob:
-   :maxdepth: 1
+   .. include:: next_whats_new/README.rst
+   .. toctree::
+      :glob:
+      :maxdepth: 1
 
-   next_whats_new/*
+      next_whats_new/*
 
 
 New in Matplotlib 2.2
