Skip to content

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

Open
rafaumeu wants to merge 2 commits into
mattermost:masterfrom
rafaumeu:fix/furo-upgrade-right-panel-7019
Open

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

Conversation

@rafaumeu

Copy link
Copy Markdown

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

rafaumeu added 2 commits June 16, 2026 19:59
…st#7072)

The file common-esr-support-rst.rst is designed to be included by
multiple pages (releases-lifecycle.rst, version-archive.rst) but
lacks the :orphan: and :nosearch: metadata. When accessed directly
via URL, it displays '<no title>' in the browser tab and appears in
site search results.

Add :orphan: and :nosearch: directives to prevent it from being
indexed or showing up in search, consistent with other included-only
files like cloud-supported-integrations.rst and badge files.
…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 16, 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: 73f9b93a-1bfa-490a-bad6-f827e766f937

📥 Commits

Reviewing files that changed from the base of the PR and between 940b724 and af809e9.

⛔ Files ignored due to path filters (1)
  • Pipfile.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • Pipfile
  • source/product-overview/common-esr-support-rst.rst

📝 Walkthrough

Walkthrough

Bumps the furo Sphinx theme dev dependency in Pipfile from ==2024.8.6 to ==2025.12.19. Additionally, adds :orphan: and :nosearch: Sphinx directives to source/product-overview/common-esr-support-rst.rst to exclude that page from toctree navigation and search indexing.

Changes

Furo Dependency Upgrade

Layer / File(s) Summary
Bump furo dev dependency
Pipfile
Updates the furo version pin in dev-packages from ==2024.8.6 to ==2025.12.19.

RST Orphan and Nosearch Directives

Layer / File(s) Summary
Add :orphan: and :nosearch: to ESR support page
source/product-overview/common-esr-support-rst.rst
Prepends :orphan: and :nosearch: directives at the top of the file, removing it from toctree navigation and search indexing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly summarizes the main change: upgrading Furo to fix a specific right panel highlight offset issue.
Description check ✅ Passed The description is related to the changeset, providing context about the Furo upgrade, root cause of the highlight offset issue, and the fix included in the new version.
Linked Issues check ✅ Passed The pull request successfully addresses all requirements from issue #7019 by upgrading Furo to version 2025.12.19, which includes the fix for the right panel highlight offset issue caused by sticky elements.
Out of Scope Changes check ✅ Passed The changes to Pipfile and the RST documentation file (adding orphan/nosearch directives) are both within scope of the Furo upgrade and documentation maintenance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help Wanted: Right panel highlight is one index previous

2 participants