Skip to content

Various documentation updates #8955

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

Merged
choldgraf merged 6 commits into from
Jul 30, 2017
Merged

Various documentation updates #8955

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
087b18c
Rename doc/users/{whats_new => next_whats_new}/
QuLogic Jul 27, 2017
0e396e6
Add 2.1 what's new into docs.
QuLogic Jul 27, 2017
2e8817f
Fix link to legend demo in what's new.
QuLogic Jul 27, 2017
866691b
Fix backreference URLs.
QuLogic Jul 27, 2017
7e97a37
Set SSH key to use for deployment.
QuLogic Jul 29, 2017
0c44435
Skip deployment if not on Matplotlib org.
QuLogic Jul 29, 2017
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
Prev Previous commit
Next Next commit
Add 2.1 what's new into docs. 
This allows us to check that they're written correctly before getting
around to a release.
  • Loading branch information
@QuLogic
QuLogic committed Jul 30, 2017
commit 0e396e6cd0c8bb3e4b91c929f9a73c22168cb202
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ detail. Why is this change required? What problem does it solve?-->
- [ ] Code is PEP 8 compliant
- [ ] New features are documented, with examples if plot related
- [ ] Documentation is sphinx and numpydoc compliant
- [ ] Added an entry to doc/users/whats_new.rst if major new feature
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

<!--We understand that PRs can sometimes be overwhelming, especially as the
Expand Down
5 changes: 4 additions & 1 deletion doc/devel/release_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ Review and commit changes. Some issue/PR titles may not be valid rst (the most
Check Docs
----------

Before tagging, make sure that the docs build cleanly ::
Before tagging, update the what's new listing in :file:`doc/users/whats_new.rst`
Copy link
Copy Markdown
Contributor

@choldgraf choldgraf Jul 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it should be done in this PR, but I still think it'd be good to have some kind of "credit" system for various features. E.g. just making sure that every new feature or bugfix has a by XXX at the end, optionally with a link to a user webpage or something.

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 ::

pushd doc
python make.py html latex -n 16
Expand Down
5 changes: 4 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
@@ -1,4 +1,7 @@
This folder is for placing new portions of `whats_new.rst`.
What's new in unreleased Matplotlib?
====================================

Please place new portions of `whats_new.rst` in the `next_whats_new` directory.

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
Expand Down
10 changes: 10 additions & 0 deletions doc/users/whats_new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ revision, see the :ref:`github-stats`.
:depth: 3


..
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

next_whats_new/*


New in matplotlib 2.0
=====================
Expand Down