X Tutup
Skip to content

Download the depsy.org badge when building the html documentation #8446

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
NelleV merged 2 commits into from
Apr 8, 2017
Merged

Download the depsy.org badge when building the html documentation #8446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a75d55
Download the depsy.org badge when building the html documentation
jkseppan Apr 8, 2017
ee4ec51
Fix for Python 2
jkseppan Apr 8, 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
1 change: 1 addition & 0 deletions doc/_static/depsy_badge_default.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/_templates/badgesidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
<img src="{{ pathto('_static/depsy_badge.svg', 1) }}">
</a>

<br/>
Expand Down
29 changes: 29 additions & 0 deletions doc/make.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import argparse
import subprocess
import matplotlib
import six


def copy_if_out_of_date(original, derived):
Expand Down Expand Up @@ -90,10 +91,38 @@ def generate_frontpage_pngs(only_if_needed=True):
os.rename(fn_png, pn_png) # move file to _static/ directory


DEPSY_PATH = "_static/depsy_badge.svg"
DEPSY_URL = "http://depsy.org/api/package/pypi/matplotlib/badge.svg"
DEPSY_DEFAULT = "_static/depsy_badge_default.svg"


def fetch_depsy_badge():
"""Fetches a static copy of the depsy badge.

If there is any network error, use a static copy from git.

This is to avoid a mixed-content warning when serving matplotlib.org
over https, see https://github.com/Impactstory/depsy/issues/77

The downside is that the badge only updates when the documentation
is rebuilt."""
try:
request = six.moves.urllib.request.urlopen(DEPSY_URL)
try:
data = request.read().decode('utf-8')
with open(DEPSY_PATH, 'w') as output:
output.write(data)
finally:
request.close()
except six.moves.urllib.error.URLError:
shutil.copyfile(DEPSY_DEFAULT, DEPSY_PATH)


def html(buildername='html'):
"""Build Sphinx 'html' target. """
check_build()
generate_frontpage_pngs()
fetch_depsy_badge()

rc = '../lib/matplotlib/mpl-data/matplotlibrc'
default_rc = os.path.join(matplotlib._get_data_path(), 'matplotlibrc')
Expand Down
X Tutup