Remove deprecated option for google analytics

pydata · Oct 7, 2022 · a49017c · a49017c
1 parent 355fe0b
commit a49017c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 50 deletions.
diff --git a/src/pydata_sphinx_theme/__init__.py b/src/pydata_sphinx_theme/__init__.py
@@ -2,7 +2,6 @@
 Bootstrap-based sphinx theme from the PyData community
 """
 import os
-import warnings
 from pathlib import Path
 from functools import lru_cache
 import json
@@ -111,18 +110,6 @@ def update_config(app, env):
 
     # Add an analytics ID to the site if provided
     analytics = theme_options.get("analytics", {})
-    # deprecated options for Google Analytics
-    # TODO: deprecate >= v0.12
-    gid = theme_options.get("google_analytics_id")
-    if gid:
-        msg = (
-            "'google_analytics_id' is deprecated and will be removed in "
-            "version 0.11, please refer to the documentation "
-            "and use 'analytics' instead."
-        )
-        warnings.warn(msg, DeprecationWarning, stacklevel=2)
-        analytics.update({"google_analytics_id": gid})
-
     if analytics:
         # Plausible analytics
         plausible_domain = analytics.get("plausible_analytics_domain")
@@ -137,29 +124,16 @@ def update_config(app, env):
             }
             app.add_js_file(**kwargs)
 
-        # Two types of Google Analytics id.
+        # Google Analytics
         gid = analytics.get("google_analytics_id")
         if gid:
-            # In this case it is "new-style" google analytics
-            if "G-" in gid:
-                gid_js_path = f"https://www.googletagmanager.com/gtag/js?id={gid}"
-                gid_script = f"""
-                    window.dataLayer = window.dataLayer || [];
-                    function gtag(){{ dataLayer.push(arguments); }}
-                    gtag('js', new Date());
-                    gtag('config', '{gid}');
-                """
-            # In this case it is "old-style" google analytics
-            else:
-                gid_js_path = "https://www.google-analytics.com/analytics.js"
-                gid_script = f"""
-                    window.ga = window.ga || function () {{
-                        (ga.q = ga.q || []).push(arguments) }};
-                    ga.l = +new Date;
-                    ga('create', '{gid}', 'auto');
-                    ga('set', 'anonymizeIp', true);
-                    ga('send', 'pageview');
-                """
+            gid_js_path = f"https://www.googletagmanager.com/gtag/js?id={gid}"
+            gid_script = f"""
+                window.dataLayer = window.dataLayer || [];
+                function gtag(){{ dataLayer.push(arguments); }}
+                gtag('js', new Date());
+                gtag('config', '{gid}');
+            """
 
             # Link the JS files
             app.add_js_file(gid_js_path, loading_method="async")

diff --git a/tests/test_build.py b/tests/test_build.py
@@ -547,11 +547,6 @@ def test_edit_page_url(sphinx_build_factory, html_context, edit_url):
 @pytest.mark.parametrize(
     "provider,tags",
     [
-        # TODO: Deprecate old-style analytics config >= 0.12
-        # new_google_analytics_id
-        ({"html_theme_options.google_analytics_id": "G-XXXXX"}, ["gtag", "G-XXXXX"]),
-        # old_google_analytics_id
-        ({"html_theme_options.google_analytics_id": "UA-XXXXX"}, ["ga", "UA-XXXXX"]),
         # google analytics
         (
             {"html_theme_options.analytics": {"google_analytics_id": "G-XXXXX"}},
@@ -568,17 +563,6 @@ def test_edit_page_url(sphinx_build_factory, html_context, edit_url):
             },
             ["gtag", "G-XXXXX"],
         ),
-        # TODO: Deprecate old-style analytics config >= 0.12
-        (
-            {
-                "html_theme_options.analytics": {
-                    "plausible_analytics_domain": "toto",
-                    "plausible_analytics_url": "http://.../script.js",
-                },
-                "html_theme_options.google_analytics_id": "G-XXXXX",
-            },
-            ["gtag", "G-XXXXX"],
-        ),
     ],
 )
 def test_analytics(sphinx_build_factory, provider, tags):