Skip to content

Remove some manual manipulation of whatsnew when releasing.#10573

Closed
anntzer wants to merge 1 commit into
matplotlib:masterfrom
anntzer:docifconfig
Closed

Remove some manual manipulation of whatsnew when releasing.#10573
anntzer wants to merge 1 commit into
matplotlib:masterfrom
anntzer:docifconfig

Conversation

@anntzer

@anntzer anntzer commented Feb 23, 2018

Copy link
Copy Markdown
Contributor

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.

Noted while reviewing #10548.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • 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/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

@anntzer anntzer added this to the v3.0 milestone Feb 23, 2018
@anntzer

anntzer commented Mar 5, 2018

Copy link
Copy Markdown
Contributor Author

rebased

@anntzer anntzer force-pushed the docifconfig branch 2 times, most recently from 78d9dbd to e37028c Compare March 5, 2018 01:55
@jklymak

jklymak commented Mar 6, 2018

Copy link
Copy Markdown
Member

Should the doc builds not work?

@anntzer

anntzer commented Mar 6, 2018

Copy link
Copy Markdown
Contributor Author

Can't reproduce the failure locally (the whatsnew gets included)...

@jklymak

jklymak commented Mar 21, 2018

Copy link
Copy Markdown
Member

I suspect a rebase will fix this; I had this error for something as well that shouldn't have had the error, but it worked after a rebase?

@anntzer

anntzer commented Mar 21, 2018

Copy link
Copy Markdown
Contributor Author

rebased

@tacaswell

Copy link
Copy Markdown
Member

Can you extend this to api_changes too?

@tacaswell tacaswell modified the milestones: v3.0, v2.2-doc Mar 22, 2018
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.
@anntzer

anntzer commented Mar 23, 2018

Copy link
Copy Markdown
Contributor Author

Done.
I believe that the build "failure" is due to a spurious sphinx warning: sphinx-doc/sphinx#4770.

(but I guess it may still make sense to wait until the issue is fixed on sphinx's side before merging this, so that we don't start universally failing doc builds...)

@anntzer

anntzer commented Mar 27, 2018

Copy link
Copy Markdown
Contributor Author

Temporarily closing until the issue is fixed upstream.

@anntzer anntzer closed this Mar 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants