10000 Add 2.1 what's new into docs. · keithbriggs/matplotlib@0e396e6 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0e396e6

Browse files
committed
Add 2.1 what's new into docs.
This allows us to check that they're written correctly before getting around to a release.
1 parent 087b18c commit 0e396e6

File tree

4 files changed

+19
-3
lines changed

4 files changed

+19
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ detail. Why is this change required? What problem does it solve?-->
2424
- [ ] Code is PEP 8 compliant
2525
- [ ] New features are documented, with examples if plot related
2626
- [ ] Documentation is sphinx and numpydoc compliant
27-
- [ ] Added an entry to doc/users/whats_new.rst if major new feature
27+
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
2828
- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way
2929

3030
<!--We understand that PRs can s 10000 ometimes be overwhelming, especially as the

doc/devel/release_guide.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,10 @@ Review and commit changes. Some issue/PR titles may not be valid rst (the most
4848
Check Docs
4949
----------
5050

51-
Before tagging, make sure that the docs build cleanly ::
51+
Before tagging, update the what's new listing in :file:`doc/users/whats_new.rst`
52+
by merging all files in :file:`doc/users/next_whats_new/` coherently. Also,
53+
temporarily comment out the include and toctree glob; re-instate these after a
54+
release. Finally, make sure that the docs build cleanly ::
5255

5356
pushd doc
5457
python make.py html latex -n 16

doc/users/next_whats_new/README.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
This folder is for placing new portions of `whats_new.rst`.
1+
What's new in unreleased Matplotlib?
2+
====================================
3+
4+
Please place new portions of `whats_new.rst` in the `next_whats_new` directory.
25

36
When adding an entry please look at the currently existing files to
47
see if you can extend any of them. If you create a file, name it

doc/users/whats_new.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ revision, see the :ref:`github-stats`.
1111
:depth: 3
1212

1313

14+
..
15+
For a release, add a new section after this, then comment out the include
16+
and toctree below by indenting them. Uncomment them after the release.
17+
.. include:: next_whats_new/README.rst
18+
.. toctree::
19+
:glob:
20+
:maxdepth: 1
21+
22+
next_whats_new/*
23+
1424

1525
New in matplotlib 2.0
1626
=====================

0 commit comments

Comments
 (0)
0