Disable version switcher on circleci

dstansby · dstansby · commit 4c030e9635c9 · 2024-03-04T20:42:05.000Z
diff --git a/doc/conf.py b/doc/conf.py
@@ -479,7 +479,19 @@ def js_tag_with_cache_busting(js):
     # and CI builds https://github.com/pydata/pydata-sphinx-theme/pull/386
     "collapse_navigation": not is_release_build,
     "show_prev_next": False,
-    "switcher": {
+    "navbar_end": ["theme-switcher", "version-switcher", "mpl_icon_links"],
+    "navbar_persistent": ["search-button"],
+    "footer_start": ["copyright", "sphinx-version", "doc_version"],
+    # We override the announcement template from pydata-sphinx-theme, where
+    # this special value indicates the use of the unreleased banner. If we need
+    # an actual announcement, then just place the text here as usual.
+    "announcement": "unreleased" if not is_release_build else "",
+}
+if not CIRCLECI:
+    # CircleCI hosted docs cannot load
+    # https://matplotlib.org/devdocs/_static/switcher.json,
+    # so only enable the version switcher if not on CircleCI
+    html_theme_options["switcher"] = {
         # Add a unique query to the switcher.json url.  This will be ignored by
         # the server, but will be used as part of the key for caching by browsers
         # so when we do a new meso release the switcher will update "promptly" on
@@ -490,15 +502,7 @@ def js_tag_with_cache_busting(js):
             # We either go to 'stable' or to 'devdocs'
             'stable' if matplotlib.__version_info__.releaselevel == 'final'
             else 'devdocs')
-    },
-    "navbar_end": ["theme-switcher", "version-switcher", "mpl_icon_links"],
-    "navbar_persistent": ["search-button"],
-    "footer_start": ["copyright", "sphinx-version", "doc_version"],
-    # We override the announcement template from pydata-sphinx-theme, where
-    # this special value indicates the use of the unreleased banner. If we need
-    # an actual announcement, then just place the text here as usual.
-    "announcement": "unreleased" if not is_release_build else "",
-}
+    }
 include_analytics = is_release_build
 if include_analytics:
     html_theme_options["analytics"] = {
