feat: allow disabling of analytics through a Sphinx option#43
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Sphinx theme option to control whether Google Analytics is enabled, and threads that setting into the React nav injection so GA can be turned off for non-production builds.
Changes:
- Introduces
enable_analyticstheme option (defaultfalse) intheme.toml. - Passes the option into the DOM via
data-analytics-enabledon the.nexus-navmount element. - Conditions Google Analytics rendering on both cookie consent and the new
data-analytics-enabledflag.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sphinx-ui/react/src/injectNav.tsx | Reads data-analytics-enabled and uses it to gate GA rendering. |
| sphinx-ui/quantinuum_sphinx/theme.toml | Adds enable_analytics option with default false and inline guidance. |
| sphinx-ui/quantinuum_sphinx/page.html | Emits data-analytics-enabled from theme_enable_analytics into the mount element. |
| sphinx-ui/demo/source/conf.py | Documents how to enable analytics via html_theme_options. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.