From e2b60d7e7b2b6feb8a45b224950608ad11668a7e Mon Sep 17 00:00:00 2001 From: Nils K <24257556+septatrix@users.noreply.github.com> Date: Fri, 9 Oct 2020 01:28:19 +0200 Subject: [PATCH] Add analytics_anonymize_ip option to theme (#889) * Add analytics_anonymize_ip option to theme * Fix typo and use tobool filter Co-Authored-By: Jesse Tan * Simplify analytics_anonymize_ip description * Update changelog.rst Co-authored-by: Jesse Tan Co-authored-by: Aaron Carlisle --- docs/changelog.rst | 5 +++++ docs/configuring.rst | 8 ++++++++ sphinx_rtd_theme/layout.html | 3 +++ sphinx_rtd_theme/theme.conf | 3 ++- 4 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index caf8575f6..f178469a6 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,6 +5,11 @@ Changelog master ====== +New Features +------------ + +* New theme option to enable anonymous ip addresses when using Google Analytics (#889) + v0.5.0 ====== diff --git a/docs/configuring.rst b/docs/configuring.rst index 42b64340a..85cafffac 100644 --- a/docs/configuring.rst +++ b/docs/configuring.rst @@ -15,6 +15,7 @@ For example: html_theme_options = { 'canonical_url': '', 'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard + 'analytics_anonymize_ip': False, 'logo_only': False, 'display_version': True, 'prev_next_buttons_location': 'bottom', @@ -101,6 +102,13 @@ Miscellaneous options If specified, Google Analytics' javascript is included in your pages. Set the value to the ID provided to you by google (like ``UA-XXXXXXX``). +.. confval:: analytics_anonymize_ip + + :type: boolean + :default: ``False`` + + Anonymize visitor IP addresses in Google Analytics. + .. confval:: canonical_url :type: URL diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index 1afe3f06e..90c409514 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -229,6 +229,9 @@ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', '{{ theme_analytics_id }}', 'auto'); + {% if theme_analytics_anonymize_ip|tobool %} + ga('set', 'anonymizeIp', true); + {% endif %} ga('send', 'pageview'); diff --git a/sphinx_rtd_theme/theme.conf b/sphinx_rtd_theme/theme.conf index fd0521f02..91731083f 100644 --- a/sphinx_rtd_theme/theme.conf +++ b/sphinx_rtd_theme/theme.conf @@ -6,6 +6,7 @@ pygments_style = default [options] canonical_url = analytics_id = +analytics_anonymize_ip = False collapse_navigation = True sticky_navigation = True navigation_depth = 4 @@ -15,4 +16,4 @@ logo_only = display_version = True prev_next_buttons_location = bottom style_external_links = False -style_nav_header_background = \ No newline at end of file +style_nav_header_background =