Skip to content

Use the Agg backend for docs builds #21914

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
Jul 17, 2018
Merged

Conversation

tdsmith
Copy link
Contributor

@tdsmith tdsmith commented Jul 14, 2018

This uses a non-interactive Agg matplotlib backend to build docs, which avoids trying to use the default MacOS backend, which can fail in some environments.

Closes #21913.

This uses a non-interactive Agg matplotlib backend to build docs, which avoids trying to use the default MacOS backend, which can fail in some environments.

Closes pandas-dev#21913.
@codecov
Copy link

codecov bot commented Jul 15, 2018

Codecov Report

Merging #21914 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #21914   +/-   ##
=======================================
  Coverage   91.96%   91.96%           
=======================================
  Files         166      166           
  Lines       50323    50323           
=======================================
  Hits        46281    46281           
  Misses       4042     4042
Flag Coverage Δ
#multiple 90.36% <ø> (ø) ⬆️
#single 42.22% <ø> (-0.01%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2b51c96...24ca96c. Read the comment docs.

@jschendel jschendel added the Docs label Jul 15, 2018
@jreback jreback added this to the 0.24.0 milestone Jul 16, 2018
@jreback
Copy link
Contributor

jreback commented Jul 16, 2018

@datapythonista
Copy link
Member

Looks good, tested on Linux.

I was just guessing whether it'd be possible to set an environment variable in conf.py instead of creating a new file. Not a big deal, but there are already many files in doc/source and if it's the same, I'd prefer changing conf.py than adding a new file.

I'd say this link is about the same problem: https://stackoverflow.com/questions/25124977/cant-use-sphinxs-matplotlib-extension-with-qt-on-os-x#25164523

What do you think @tdsmith ?

@jorisvandenbossche
Copy link
Member

Just to check, this has no influence on how the figures look in the docs? (the quality)

@datapythonista
Copy link
Member

No quality difference that I can spot:

screenshot at 2018-07-16 14-53-38

@jorisvandenbossche
Copy link
Member

I would also assume this can be set in conf.py

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Thanks @tdsmith, lgtm.

@tdsmith
Copy link
Contributor Author

tdsmith commented Jul 16, 2018

Thanks for the review, all! I just realized you asked for conf.py and not make.py -- it works for me in either place; AFAICT tweaking the environment is still the right thing to do in either place.

@jreback jreback merged commit a860028 into pandas-dev:master Jul 17, 2018
@jreback
Copy link
Contributor

jreback commented Jul 17, 2018

thanks @tdsmith

aeltanawy pushed a commit to aeltanawy/pandas that referenced this pull request Jul 20, 2018
* Use the Agg backend for docs builds

This uses a non-interactive Agg matplotlib backend to build docs, which avoids trying to use the default MacOS backend, which can fail in some environments.

Closes pandas-dev#21913.

* Modify make.py instead of adding a matplotlibrc
Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
* Use the Agg backend for docs builds

This uses a non-interactive Agg matplotlib backend to build docs, which avoids trying to use the default MacOS backend, which can fail in some environments.

Closes pandas-dev#21913.

* Modify make.py instead of adding a matplotlibrc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants