Skip to content

Remove some manual manipulation of whatsnew when releasing. #10573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Remove some manual manipulation of whatsnew when releasing. #10573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions doc/api/api_changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ out what caused the breakage and how to fix it by updating your code.
For new features that were added to Matplotlib, please see
:ref:`whats-new`.

.. for a release comment out the toctree below
.. ifconfig:: __import__('pkg_resources').parse_version(version).local

.. toctree::
:glob:
:maxdepth: 1

.. toctree::
:glob:
:maxdepth: 1

next_api_changes/*
next_api_changes/*


API Changes in 2.2.0
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 4 additions & 4 deletions doc/devel/release_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion doc/users/next_whats_new/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ When adding an entry please look at the currently existing files to
see if you can extend any of them. If you create a file, name it
something like :file:`cool_new_feature.rst` if you have added a brand new
feature or something like :file:`updated_feature.rst` for extensions of
existing features. Include contents of the form: ::
existing features. Include contents of the form:

.. code-block:: rst

Section Title for Feature
-------------------------
Expand Down
14 changes: 6 additions & 8 deletions doc/users/whats_new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down