Skip to content

feat: allow disabling of analytics through a Sphinx option #43

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.

Sign up for GitHub

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

Merged
sburton84 merged 1 commit into from
Jul 1, 2026
Merged

feat: allow disabling of analytics through a Sphinx option #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions sphinx-ui/demo/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,10 @@

html_theme = 'quantinuum_sphinx'
html_static_path = ['_static']

# Google Analytics is disabled by default so non-production environments
# (e.g. staging) do not send analytics. Enable it only in the production
# build's conf.py:
# html_theme_options = {
# 'enable_analytics': True,
# }
2 changes: 1 addition & 1 deletion sphinx-ui/quantinuum_sphinx/page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<!--Force light mode -->
<script>document.body.setAttribute('data-theme','light')</script>
<nav style="position:fixed;top:0;z-index:1021;width:100%;">
<div class="nexus-nav"></div>
<div class="nexus-nav" data-analytics-enabled="{{ 'true' if theme_enable_analytics else 'false' }}"></div>
</nav>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
Expand Down
6 changes: 6 additions & 0 deletions sphinx-ui/quantinuum_sphinx/theme.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,9 @@ stylesheets = [
"styles/quantinuum-ui-tailwind.css",
"styles/quantinuum-sphinx.css",
]

[options]
# Enable Google Analytics. Disabled by default so non-production
# environments (e.g. staging) do not send analytics. Set to true in the
# production conf.py via html_theme_options = {"enable_analytics": True}.
enable_analytics = false
4 changes: 3 additions & 1 deletion sphinx-ui/react/src/injectNav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ const observeTailwindDialogPortalElements = () => {
const mountElement = document.querySelector('.nexus-nav')
if (!mountElement) return

const analyticsEnabled = mountElement.getAttribute('data-analytics-enabled') === 'true'

observeTailwindDialogPortalElements()

const renderIn = document.createElement('div')
Expand All @@ -106,7 +108,7 @@ const observeTailwindDialogPortalElements = () => {
<div className="antialiased" style={{ fontFamily: `Inter, ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"` }}>
<CookieConsentProvider version={1}>
<CookieConditional category={CookieCategoryName.Analytics} fallback={null}>
{GA_ID && <GoogleAnalytics gaId={GA_ID} />}
{analyticsEnabled && GA_ID && <GoogleAnalytics gaId={GA_ID} />}
</CookieConditional>
<DocsNavBar activePath="/" />
<CookieConsentManager />
Comment thread
sburton84 marked this conversation as resolved.
Expand Down