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

Fix Google Analytics in Read The Docs #3933

Closed
3 tasks done
zaneselvans opened this issue Oct 28, 2024 · 2 comments · Fixed by #3934
Closed
3 tasks done

Fix Google Analytics in Read The Docs #3933

zaneselvans opened this issue Oct 28, 2024 · 2 comments · Fixed by #3934
Assignees
Labels
bug Things that are just plain broken. docs Documentation for users and contributors.

Comments

@zaneselvans
Copy link
Member

zaneselvans commented Oct 28, 2024

Describe the bug

Read The Docs recently stopped adding Google Analytics tracking IDs into their docs builds. This has broken our docs usage tracking.

image

More information in this blog post that we totally missed.

We can address this with a Sphinx Google Analytics plug-in. It doesn't look like there's a simple RTD-only configuration option like there was before the "Analytics" that can be configured on the site itself are now just the simple RTD analytics.

Tasks

  1. python review-requested staged-recipes
  2. dependencies docs
    zaneselvans
@zaneselvans zaneselvans added bug Things that are just plain broken. docs Documentation for users and contributors. labels Oct 28, 2024
@zaneselvans zaneselvans self-assigned this Oct 28, 2024
@zaneselvans
Copy link
Member Author

It looks like sphinxcontrib-googleanalytics is not available on conda-forge. Sigh.

@zaneselvans zaneselvans linked a pull request Oct 28, 2024 that will close this issue
@zaneselvans zaneselvans moved this from New to In progress in Catalyst Megaproject Oct 28, 2024
@zaneselvans zaneselvans moved this from In progress to In review in Catalyst Megaproject Nov 1, 2024
@zaneselvans
Copy link
Member Author

Because adding the google analytics code is now something that happens in the docs build -- and requires a new package and a change to conf.py -- rather than being something that's added by RTD, we can't enable the collection of analytics on earlier versions of the docs without updating already released versions / changing where the tags point. Not sure if it's worth doing that. Almost everyone just uses the default version of the docs.

@github-project-automation github-project-automation bot moved this from In review to Done in Catalyst Megaproject Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Things that are just plain broken. docs Documentation for users and contributors.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant