Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add analytics_anonymize_ip option to theme #889

Merged
merged 7 commits into from Oct 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/changelog.rst
Expand Up @@ -5,6 +5,11 @@ Changelog
master
======

New Features
------------

* New theme option to enable anonymous ip addresses when using Google Analytics (#889)

v0.5.0
======

Expand Down
8 changes: 8 additions & 0 deletions docs/configuring.rst
Expand Up @@ -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',
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions sphinx_rtd_theme/layout.html
Expand Up @@ -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');
</script>

Expand Down
3 changes: 2 additions & 1 deletion sphinx_rtd_theme/theme.conf
Expand Up @@ -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
Expand All @@ -15,4 +16,4 @@ logo_only =
display_version = True
prev_next_buttons_location = bottom
style_external_links = False
style_nav_header_background =
style_nav_header_background =