| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -24,7 +24,7 @@ detail. Why is this change required? What problem does it solve?--> | |||
| 24 | 24 | - [ ] Code is PEP 8 compliant | |
| 25 | 25 | - [ ] New features are documented, with examples if plot related | |
| 26 | 26 | - [ ] 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) | ||
| 28 | 28 | - [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way | |
| 29 | 29 | ||
| 30 | 30 | <!--We understand that PRs can sometimes be overwhelming, especially as the | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -48,7 +48,10 @@ Review and commit changes. Some issue/PR titles may not be valid rst (the most | |||
| 48 | 48 | Check Docs | |
| 49 | 49 | ---------- | |
| 50 | 50 | ||
| 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 :: | ||
| 52 | 55 | ||
| 53 | 56 | pushd doc | |
| 54 | 57 | python make.py html latex -n 16 | |
| Original file line number | Diff line number | Diff 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. | ||
| 2 | 5 | ||
| 3 | 6 | When adding an entry please look at the currently existing files to | |
| 4 | 7 | see if you can extend any of them. If you create a file, name it | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -11,6 +11,16 @@ revision, see the :ref:`github-stats`. | |||
| 11 | 11 | :depth: 3 | |
| 12 | 12 | ||
| 13 | 13 | ||
| 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 | + | ||
| 14 | 24 | ||
| 15 | 25 | New in matplotlib 2.0 | |
| 16 | 26 | ===================== | |
| Back | FazBrowse Home | New Git URL |
0 commit comments