From: Anil Belur <abelur@linuxfoundation.org>
Date: Thu, 15 Jan 2026 10:44:55 +0000 (+1000)
Subject: fix: Pin Sphinx<9.0.0 for sphinx-tabs compatibility
X-Git-Tag: v0.10.0~1
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F58%2F74058%2F2;p=releng%2Fdocs-conf.git

fix: Pin Sphinx<9.0.0 for sphinx-tabs compatibility

Sphinx 9.0.0 introduced breaking changes that cause sphinx-tabs
to fail with KeyError: 'backrefs' in tabs.py line 69.

This affects projects like bgpcep where tox docs builds fail:
https://jenkins.opendaylight.org/releng/job/bgpcep-tox-verify-master/1719/console

Root cause: sphinx-tabs has not been updated for Sphinx 9.x yet.
See: https://github.com/executablebooks/sphinx-tabs/issues/206

Pin Sphinx to <9.0.0 until sphinx-tabs releases a compatible version.

Issue-ID: IT-29177
Change-Id: Ic69a55380709003c0a9911c9bf29f374a1d2f0a9
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
---

diff --git a/requirements.txt b/requirements.txt
index df60db1..733e25f 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,5 +1,5 @@
 PyYAML  # MIT
-Sphinx>=4.2.0  # BSD
+Sphinx>=4.2.0,<9.0.0  # BSD
 sphinx_bootstrap_theme
 sphinx-tabs
 sphinxcontrib-blockdiag  # BSD