Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix the docs build. #12322

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.

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
merged 2 commits into from
Sep 28, 2018
Merged

Fix the docs build. #12322

merged 2 commits into from
Sep 28, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 28, 2018

PR Summary

Don't mock wx in docs build.

Otherwise, wx.GetApp() returns a truthy value and the backend switching
machinery believes that a wx event loop is running, leading to warnings
about show() not doing anything with agg.

Builds on top of #12267. Will self-merge if passes.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

On Linux, $DISPLAY is unset, then we can't run a GUI toolkit anyways, so
don't warn about that in `show()`.

Delete the Note in the docstring which was redundant with the Parameters
entry.
Otherwise, wx.GetApp() returns a truthy value and the backend switching
machinery believes that a wx event loop is running, leading to warnings
about show() not doing anything with agg.
@dstansby
Copy link
Member

Is it possible to make wx.GetAp() return False in the mock object instead? It would be nice not to lose the docs...

@anntzer
Copy link
Contributor Author

anntzer commented Sep 28, 2018

We already got rid of qt and gtk docs for the same reason. I'd rather write a proper unified interactive backends doc at some point...

@jklymak
Copy link
Member

jklymak commented Sep 28, 2018

Issue (which I dont' completely understand) noted in #12324: Merging to unbreak the build.

@jklymak jklymak merged commit 2ec59bd into matplotlib:master Sep 28, 2018
@anntzer anntzer deleted the wxless-docs branch September 28, 2018 15:50
@tacaswell tacaswell added this to the v3.1 milestone Sep 28, 2018
@QuLogic
Copy link
Member

QuLogic commented Sep 28, 2018

@meeseeksdev backport to v3.0.x
@meeseeksdev backport to v3.0.0-doc

cf #12327 and #12328

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 28, 2018
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 28, 2018
QuLogic added a commit that referenced this pull request Sep 28, 2018
…322-on-v3.0.0-doc

Backport PR #12322 on branch v3.0.0-doc (Fix the docs build.)
QuLogic added a commit that referenced this pull request Sep 28, 2018
…322-on-v3.0.x

Backport PR #12322 on branch v3.0.x (Fix the docs build.)
@QuLogic QuLogic modified the milestones: v3.1, v3.0.0-doc Sep 28, 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.

5 participants