fix: update google_analytics_id alias

jupyter-book · May 28, 2024 · b985ac3 · b985ac3
1 parent b08c12d
commit b985ac3
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -25,14 +25,13 @@ html:
   # Then we could link to the changelog in the *same* build of the docs.
   announcement: '⚠️The 0.13 release refactored our HTML, so double-check your custom CSS rules!⚠️'
   favicon: images/favicon.ico
-  google_analytics_id: UA-52617120-7
   home_page_in_navbar: false
   use_edit_page_button: true
   use_repository_button: true
   use_issues_button: true
   baseurl: https://jupyterbook.org/
   analytics:
-    google_analytics_id = ''
+    google_analytics_id: UA-52617120-7
 
 repository:
   url: https://github.com/executablebooks/jupyter-book

diff --git a/docs/advanced/html.md b/docs/advanced/html.md
@@ -131,7 +131,8 @@ Analytics) into the following directive in your configuration file:
 
 ```yaml
 html:
-  google_analytics_id: G-XXXXXXX
+  analytics:
+    google_analytics_id: G-XXXXXXX
 ```
 
 :::{seealso}

diff --git a/jupyter_book/config.py b/jupyter_book/config.py
@@ -188,6 +188,18 @@ def get_final_config(
     if sphinx_config.get("use_multitoc_numbering"):
         sphinx_config["extensions"].append("sphinx_multitoc_numbering")
 
+    # Fix for renamed field
+    google_analytics_id = sphinx_config.get("html", {}).get("google_analytics_id")
+    if google_analytics_id is not None:
+        _message_box(
+            (
+                "[Warning] The `html.google_analytics_id` configuration value has moved to `html.analytics.google_analytics_id`"  # noqa: E501
+            ),
+            color="orange",
+            print_func=print,
+        )
+        sphinx_config['html']['google_analytics_id'] = google_analytics_id
+
     # finally merge in CLI configuration
     _recursive_update(sphinx_config, cli_config or {})