Skip to content

Commit 9ee283c

Browse files
authored
Merge pull request #4522 from rtfd/davidfischer/media-to-static-cleanup
Use the STATIC_URL for static files to avoid redirection
2 parents cfc278b + 92e95ce commit 9ee283c

File tree

5 files changed

+24
-26
lines changed

5 files changed

+24
-26
lines changed

readthedocs/doc_builder/backends/mkdocs.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@
2020
log = logging.getLogger(__name__)
2121

2222

23-
def get_absolute_media_url():
23+
def get_absolute_static_url():
2424
"""
25-
Get the fully qualified media URL from settings.
25+
Get the fully qualified static URL from settings.
2626
27-
Mkdocs needs a full domain because it tries to link to local media files.
27+
Mkdocs needs a full domain because it tries to link to local files.
2828
"""
29-
media_url = settings.MEDIA_URL
29+
static_url = settings.STATIC_URL
3030

31-
if not media_url.startswith('http'):
31+
if not static_url.startswith('http'):
3232
domain = getattr(settings, 'PRODUCTION_DOMAIN')
33-
media_url = 'http://{}{}'.format(domain, media_url)
33+
static_url = 'http://{}{}'.format(domain, static_url)
3434

35-
return media_url
35+
return static_url
3636

3737

3838
class BaseMkdocs(BaseBuilder):
@@ -108,15 +108,15 @@ def append_conf(self, **__):
108108
user_config['docs_dir'] = docs_dir
109109

110110
# Set mkdocs config values
111-
media_url = get_absolute_media_url()
111+
static_url = get_absolute_static_url()
112112
user_config.setdefault('extra_javascript', []).extend([
113113
'readthedocs-data.js',
114-
'%sstatic/core/js/readthedocs-doc-embed.js' % media_url,
115-
'%sjavascript/readthedocs-analytics.js' % media_url,
114+
'%score/js/readthedocs-doc-embed.js' % static_url,
115+
'%sjavascript/readthedocs-analytics.js' % static_url,
116116
])
117117
user_config.setdefault('extra_css', []).extend([
118-
'%scss/badge_only.css' % media_url,
119-
'%scss/readthedocs-doc-embed.css' % media_url,
118+
'%scss/badge_only.css' % static_url,
119+
'%scss/readthedocs-doc-embed.css' % static_url,
120120
])
121121

122122
docs_path = os.path.join(self.root_path, docs_dir)

readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,7 @@ else:
6767

6868
if globals().get('websupport2_base_url', False):
6969
websupport2_base_url = '{{ api_host }}/websupport'
70-
if 'http' not in settings.MEDIA_URL:
71-
websupport2_static_url = '{{ settings.STATIC_URL }}'
72-
else:
73-
websupport2_static_url = '{{ settings.MEDIA_URL }}/static'
70+
websupport2_static_url = '{{ settings.STATIC_URL }}'
7471

7572

7673
#Add project information to the template context.
@@ -80,6 +77,7 @@ context = {
8077
'current_version': "{{ version.verbose_name }}",
8178
'version_slug': "{{ version.slug }}",
8279
'MEDIA_URL': "{{ settings.MEDIA_URL }}",
80+
'STATIC_URL': "{{ settings.STATIC_URL }}",
8381
'PRODUCTION_DOMAIN': "{{ settings.PRODUCTION_DOMAIN }}",
8482
'versions': [{% for version in versions %}
8583
("{{ version.slug }}", "/{{ version.project.language }}/{{ version.slug}}/"),{% endfor %}

readthedocs/rtd_tests/tests/test_doc_builder.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,16 +153,16 @@ def test_append_conf_create_yaml(self, checkout_path, run):
153153
self.assertEqual(
154154
config['extra_css'],
155155
[
156-
'http://readthedocs.org/media/css/badge_only.css',
157-
'http://readthedocs.org/media/css/readthedocs-doc-embed.css'
156+
'http://readthedocs.org/static/css/badge_only.css',
157+
'http://readthedocs.org/static/css/readthedocs-doc-embed.css'
158158
]
159159
)
160160
self.assertEqual(
161161
config['extra_javascript'],
162162
[
163163
'readthedocs-data.js',
164-
'http://readthedocs.org/media/static/core/js/readthedocs-doc-embed.js',
165-
'http://readthedocs.org/media/javascript/readthedocs-analytics.js',
164+
'http://readthedocs.org/static/core/js/readthedocs-doc-embed.js',
165+
'http://readthedocs.org/static/javascript/readthedocs-analytics.js',
166166
]
167167
)
168168
self.assertIsNone(
@@ -205,16 +205,16 @@ def test_append_conf_existing_yaml_on_root(self, checkout_path, run):
205205
self.assertEqual(
206206
config['extra_css'],
207207
[
208-
'http://readthedocs.org/media/css/badge_only.css',
209-
'http://readthedocs.org/media/css/readthedocs-doc-embed.css'
208+
'http://readthedocs.org/static/css/badge_only.css',
209+
'http://readthedocs.org/static/css/readthedocs-doc-embed.css'
210210
]
211211
)
212212
self.assertEqual(
213213
config['extra_javascript'],
214214
[
215215
'readthedocs-data.js',
216-
'http://readthedocs.org/media/static/core/js/readthedocs-doc-embed.js',
217-
'http://readthedocs.org/media/javascript/readthedocs-analytics.js',
216+
'http://readthedocs.org/static/core/js/readthedocs-doc-embed.js',
217+
'http://readthedocs.org/static/javascript/readthedocs-analytics.js',
218218
]
219219
)
220220
self.assertIsNone(

readthedocs/settings/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ def USE_PROMOS(self): # noqa
349349
# Misc application settings
350350
GLOBAL_ANALYTICS_CODE = None
351351
DASHBOARD_ANALYTICS_CODE = None # For the dashboard, not docs
352-
GRAVATAR_DEFAULT_IMAGE = 'https://media.readthedocs.org/images/silhouette.png' # NOQA
352+
GRAVATAR_DEFAULT_IMAGE = 'https://assets.readthedocs.org/static/images/silhouette.png' # NOQA
353353
OAUTH_AVATAR_USER_DEFAULT_URL = GRAVATAR_DEFAULT_IMAGE
354354
OAUTH_AVATAR_ORG_DEFAULT_URL = GRAVATAR_DEFAULT_IMAGE
355355
RESTRICTEDSESSIONS_AUTHED_ONLY = True

readthedocs/templates/core/email/base.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
<tr>
6464
<td class="header">
6565
{% block header %}
66-
<img src='https://media.readthedocs.org/images/email-header.png' width="100%" height="150"style="" />
66+
<img src="https://assets.readthedocs.org/static/images/email-header.png" width="100%" height="150" />
6767
{% endblock %}
6868
</td>
6969
</tr>

0 commit comments

Comments
 (0)