Download the depsy.org badge when building the html documentation#8446
Download the depsy.org badge when building the html documentation#8446NelleV merged 2 commits intomatplotlib:masterfrom
Conversation
This should avoid the mixed-content warning at https://matplotlib.org where currently only the Depsy badge is loaded via http. Depsy bug: ourresearch/depsy#77
|
Can't we remove the depsy badge? I really don't like the changes to the make.py and the fact that we are downloading stuff everytime we build the documentation (got a university IP address blocked once because of building matplotlib's documentation too much. I'd rather avoid that experience :) ) |
urllib requests aren't context handlers in Python 2
|
Regarding downloading things every time the documentation is built: currently the badge gets downloaded by every viewer of the web page (and cached in the browser for at most half a day) so this change would reduce the load on depsy.org, assuming the site gets viewed more often than it gets built. In any case, I wrote the function so it uses a default image if the file cannot be downloaded, so you can disable the network and the build will still work (unless some other code needs the network). |
|
I'd personally remove the badge. Potential donors are very unlikely to know about depsy. If we are going to keep the badge, I'm fine downloading it, thought it'd be nice to move this code out of the make.py if we are still migrating to a more modern makefile. The reason I am worried about this patch is that it brings complexity and maintenance cost for something that I believe has little to no gain in that particular context. (Both you and potential reviewers should feel free to ignore these remarks. The code is clean and obviously works.) |
|
I am 👍 on keeping the depsy badge, it is a measure if impact of the library (if there is a better one is a different issue). @NelleV I hear your concerns about making my if we need complexity to build the docs then we would have that complexity this way or with a |
|
As I said, the solution would be to remove the badge. The badge brings little to no useful information. Matplotlib is a very well known library and people who don't know it won't know Depsy either. |
|
My experience with Makefiles is that they tend to accrete a lot of complexity and become a maintenance burden. Are there more details somewhere of the proposed documentation build system replacement? |
|
@jkseppan It's the "new" sphinx build system. It has been the default for at least the past 10 years. |
|
Download the depsy.org badge when building the html documentation
|
backported to v2.0.0-doc as 9dd5c5b |
This should avoid the mixed-content warning at https://matplotlib.org where currently only the Depsy badge is loaded via http.
Depsy bug: ourresearch/depsy#77