Merge pull request #3987 from davidfischer/subdomains-https

Subdomains use HTTPS if settings specify

Author: ericholscher

docs/settings.rst

@@ -83,6 +83,17 @@ Default: :djangosetting:`PUBLIC_DOMAIN`
 A special domain for serving public documentation.
 If set, public docs will be linked here instead of the `PRODUCTION_DOMAIN`.
 
+
+PUBLIC_DOMAIN_USES_HTTPS
+------------------------
+
+Default: ``False``
+
+If ``True`` and ``PUBLIC_DOMAIN`` is set, that domain will default to
+serving public documentation over HTTPS. By default, documentation is
+served over HTTP.
+
+
 ALLOW_ADMIN
 -----------
 

readthedocs/core/resolver.py

@@ -144,9 +144,17 @@ def resolve(self, project, protocol='http', filename='', private=None,
                 version_slug = project.get_default_version()
             private = self._get_private(project, version_slug)
 
+        domain = self.resolve_domain(project, private=private)
+
+        # Use HTTPS if settings specify
+        public_domain = getattr(settings, 'PUBLIC_DOMAIN', None)
+        use_https = getattr(settings, 'PUBLIC_DOMAIN_USES_HTTPS', False)
+        if use_https and public_domain and public_domain in domain:
+            protocol = 'https'
+
         return '{protocol}://{domain}{path}'.format(
             protocol=protocol,
-            domain=self.resolve_domain(project, private=private),
+            domain=domain,
             path=self.resolve_path(project, filename=filename, private=private,
                                    **kwargs),
         )

readthedocs/rtd_tests/tests/test_resolver.py

@@ -593,6 +593,23 @@ def test_resolver_public_domain_overrides(self):
             url = resolve(project=self.pip, private=False)
             self.assertEqual(url, 'http://docs.foobar.com/en/latest/')
 
+    @override_settings(
+        PRODUCTION_DOMAIN='readthedocs.org',
+        PUBLIC_DOMAIN='readthedocs.io',
+        USE_SUBDOMAIN=True,
+    )
+    def test_resolver_domain_https(self):
+        with override_settings(PUBLIC_DOMAIN_USES_HTTPS=True):
+            url = resolve(project=self.pip, private=True)
+            self.assertEqual(url, 'https://pip.readthedocs.io/en/latest/')
+
+            url = resolve(project=self.pip, private=False)
+            self.assertEqual(url, 'https://pip.readthedocs.io/en/latest/')
+
+        with override_settings(PUBLIC_DOMAIN_USES_HTTPS=False):
+            url = resolve(project=self.pip, private=True)
+            self.assertEqual(url, 'http://pip.readthedocs.io/en/latest/')
+
 
 class ResolverAltSetUp(object):
 

readthedocs/settings/base.py

@@ -42,6 +42,7 @@ class CommunityBaseSettings(Settings):
     # Domains and URLs
     PRODUCTION_DOMAIN = 'readthedocs.org'
     PUBLIC_DOMAIN = None
+    PUBLIC_DOMAIN_USES_HTTPS = False
     USE_SUBDOMAIN = False
     PUBLIC_API_URL = 'https://{0}'.format(PRODUCTION_DOMAIN)