Skip to content

fix: upgrade Furo to 2025.12.19 to fix right panel highlight offset (#7019)#9074

Open
rafaumeu wants to merge 2 commits into
mattermost:masterfrom
rafaumeu:fix/furo-clean
Open

fix: upgrade Furo to 2025.12.19 to fix right panel highlight offset (#7019)#9074
rafaumeu wants to merge 2 commits into
mattermost:masterfrom
rafaumeu:fix/furo-clean

Conversation

@rafaumeu

Copy link
Copy Markdown
Contributor

Summary

Upgrades Furo theme from 2024.8.6 to 2025.12.19 to fix the right panel (table of contents) highlight offset issue where the active section was highlighted one index previous to the actual current section.

Root Cause

Furo's scrollspy logic for the right sidebar ("On this page") did not account for sticky/fixed elements above the main header (like custom notification banners or headers). This caused the active section detection to be off by one.

Fix

Furo PR #664 (merged in 2024.08.06) fixed this by including

in the scroll offset calculation, making the TOC highlight resilient to sticky elements above the header.

Testing

  • Build docs locally and verify right panel highlights correct section
  • Check for any visual regressions in the theme

Fixes #7019

…attermost#7019)

The fixed notification banner breaks the right sidebar's
scrollspy section detection because it doesn't account for
sticky elements above the header. Furo PR mattermost#664 (released in
2025.07.19) fixes this by including header.top in the offset
calculation. Upgrading from 2024.8.6 to 2025.12.19 includes
this fix plus Sphinx 9 support and other improvements.
@mattermost-build

Copy link
Copy Markdown
Contributor

Hello @rafaumeu,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9f2b74d2-e6e4-4e5a-968d-12d4876fc018

📥 Commits

Reviewing files that changed from the base of the PR and between aa69671 and 719a9d9.

⛔ Files ignored due to path filters (1)
  • Pipfile.lock is excluded by !**/*.lock
📒 Files selected for processing (1)
  • Pipfile

📝 Walkthrough

Walkthrough

The furo documentation theme dependency in Pipfile is updated from version ==2024.8.6 to ==2025.12.19.

Changes

Furo Dependency Update

Layer / File(s) Summary
furo version bump
Pipfile
Pins the furo Sphinx theme to ==2025.12.19, up from ==2024.8.6.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states the Furo upgrade and the right panel highlight fix.
Description check ✅ Passed The description matches the dependency bump and explains the intended scrollspy fix.
Linked Issues check ✅ Passed The PR updates Furo to a newer release that aligns with the reported one-index offset issue.
Out of Scope Changes check ✅ Passed The change is limited to a single dependency version bump with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@esethna esethna added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Jul 1, 2026
@esethna

esethna commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

@rafaumeu there is another PR open in the repo that is meant to address this issue without upgrading the furo version: #8702

Would the changes in this PR address your concern?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Contributor preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help Wanted: Right panel highlight is one index previous

3 participants