Skip to content

Add RTD stats collection - #764

Open
JessicaS11 wants to merge 9 commits into
developmentfrom
rtd-stats
Open

Add RTD stats collection#764
JessicaS11 wants to merge 9 commits into
developmentfrom
rtd-stats

Conversation

@JessicaS11

@JessicaS11 JessicaS11 commented Jun 1, 2026

Copy link
Copy Markdown
Member

Description

After activating analytics collection on Read the Docs last fall, we thought it would be interesting to have a >90 day record of which pages are most used. This PR sets up the infrastructure to collect/combine/manage that data, per #729.

It turns out that the RTD API doesn't have fetching of analytics data implemented (which I didn't realize until I'd set up the action and a script to do so); the only way to get them is to download the csvs from the UI. Thus, the action included in this PR has the cron run commented out and the script will need to be run manually after the updates are downloaded manually. But it at least starts keeping track of the data.

The search tracking don't show much of anything interesting --> "download" is the most common search term.

The top five viewed docs pages (from 3/3/2026-6/1/2026) are:

Path Views
/user_guide/documentation/query.html 1034
/index.html 526
/example_notebooks/IS2_data_access.html 279
/getting_started/install.html 177
/example_notebooks/IS2_data_access2-subsetting 156

"Ready for review" checklist

  • Place this Pull Request (PR) in draft until it is ready for review (see below)
  • PR title is descriptive
  • PR body contains links to related and resolved issues (e.g. closes #1)
  • If needed, docs and/or README.md updated
  • If needed, unit and/or integration tests added (unsure how? see below!)
  • Mark "ready for review"

Review and merge checklist

  • All checks passing (tip: comment pre-commit.ci autofix if pre-commit is failing)
  • At least one approval
  • New contributors or contribution types acknowledged via @all-contributors add @[GitHub_handle] for a, b, and c

Tips and Tricks

Include /binder in a comment to add a Binder badge that will launch a binder notebook for the most recent commit in the PR.

Need help? We welcome contributions at every experience level. You don't have to
write tests alone — open your PR and ask for help. It's fine to let GitHub run tests
for you, via Continuous Integration (CI),
instead of running them locally. If anything fails and you're not sure why, just
let us know in a comment and we'll work with you!

Comment thread .github/workflows/rtd_analytics.yml Fixed
@codecov

codecov Bot commented Jun 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.17%. Comparing base (3c0bb63) to head (9756a33).

Additional details and impacted files
@@             Coverage Diff              @@
##           development     #764   +/-   ##
============================================
  Coverage        77.17%   77.17%           
============================================
  Files               42       42           
  Lines             3234     3234           
  Branches           402      402           
============================================
  Hits              2496     2496           
  Misses             604      604           
  Partials           134      134           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JessicaS11 JessicaS11 linked an issue Jun 2, 2026 that may be closed by this pull request
@JessicaS11
JessicaS11 marked this pull request as ready for review June 2, 2026 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

explore and implement saving of read-the-docs analytics

2 participants