Merge pull request #6131 from stsewd/use-setting-for-footer-api

Use different setting for footer api url

Author: stsewd

readthedocs/core/static-src/core/js/doc-embed/footer.js

@@ -64,7 +64,7 @@ function init() {
 
     // Get footer HTML from API and inject it into the page.
     $.ajax({
-        url: rtd.api_host + "/api/v2/footer_html/",
+        url: rtd.proxied_api_host + "/api/v2/footer_html/",
         crossDomain: true,
         xhrFields: {
             withCredentials: true,

readthedocs/core/static-src/core/js/doc-embed/rtd-data.js

@@ -53,6 +53,7 @@ function get() {
 
     var defaults = {
         api_host: 'https://readthedocs.org',
+        proxied_api_host: 'https://readthedocs.org',
         ad_free: false,
     };
 

readthedocs/core/static/core/js/readthedocs-doc-embed.js

@@ -237,6 +237,7 @@ def generate_rtd_data(self, docs_dir, mkdocs_config):
             'docroot': docs_dir,
             'source_suffix': '.md',
             'api_host': settings.PUBLIC_API_URL,
+            'proxied_api_host': settings.RTD_PROXIED_API_URL,
             'ad_free': not self.project.show_advertising,
             'commit': self.version.project.vcs_repo(self.version.slug).commit,
             'global_analytics_code': settings.GLOBAL_ANALYTICS_CODE,

readthedocs/doc_builder/backends/mkdocs.py

@@ -127,6 +127,7 @@ def get_config_params(self):
             'settings': settings,
             'conf_py_path': conf_py_path,
             'api_host': settings.PUBLIC_API_URL,
+            'proxied_api_host': settings.RTD_PROXIED_API_URL,
             'commit': self.project.vcs_repo(self.version.slug).commit,
             'versions': versions,
             'downloads': downloads,

readthedocs/doc_builder/backends/sphinx.py

@@ -96,6 +96,7 @@ context = {
     'single_version': {{ project.single_version }},
     'conf_py_path': '{{ conf_py_path }}',
     'api_host': '{{ api_host }}',
+    'proxied_api_host': '{{ proxied_api_host }}',
     'github_user': '{{ github_user }}',
     'github_repo': '{{ github_repo }}',
     'github_version': '{{ github_version }}',

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

@@ -41,6 +41,10 @@ class CommunityBaseSettings(Settings):
     PUBLIC_DOMAIN_USES_HTTPS = False
     USE_SUBDOMAIN = False
     PUBLIC_API_URL = 'https://{}'.format(PRODUCTION_DOMAIN)
+    # Some endpoints from the API can be proxied on other domain
+    # or use the same domain where the docs are being served
+    # (omit the host if that's the case).
+    RTD_PROXIED_API_URL = PUBLIC_API_URL
     EXTERNAL_VERSION_URL = None  # for pull request builds
 
     # Doc Builder Backends