Skip to content

Commit 365b546

Browse files
committed
fix: docutils error
1 parent 0e39aff commit 365b546

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

docs/source/upgrade/1-8-to-1-9.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ The theme version is displayed in the footer of the project's documentation site
1212

1313
If your project theme's version is **>=1.8**, follow this guide to get the latest version.
1414

15+
Known issues
16+
------------
17+
18+
- **sphinx-tabs incompatible with docutils 0.22+**: ``sphinx-tabs`` 3.4.7 (latest) raises a ``KeyError: 'backrefs'`` when building with docutils 0.22 or later (`executablebooks/sphinx-tabs#212 <https://github.com/executablebooks/sphinx-tabs/issues/212>`_). As a workaround, pin ``docutils<0.22`` in your project's dependencies until a new ``sphinx-tabs`` release is available.
19+
1520
What's new in 1.9
1621
------------------
1722

pyproject.toml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ authors = [{name = "David García", email = "david@techdocs.studio"}]
66
readme = "PYPI.rst"
77
requires-python = ">=3.11"
88
dependencies = [
9-
"sphinx-collapse>=0.1.1,<0.2",
9+
"sphinx-collapse>=0.1.4,<0.2",
1010
"sphinx-copybutton>=0.5.2,<0.6",
1111
"beautifulsoup4>=4.12.3,<5",
1212
"sphinx-tabs>=3.4.5,<4",
@@ -31,6 +31,7 @@ breathe = "^4.36.0"
3131
[dependency-groups]
3232
dev = [
3333
"sphinx>=9.0",
34+
"docutils<0.22", # pin until sphinx-tabs releases a fix for KeyError: 'backrefs' (executablebooks/sphinx-tabs#212)
3435
"pytest>=9.0.1",
3536
"sphinx-autobuild>=2025.08.25",
3637
"pre-commit>=4.5.0",
@@ -41,9 +42,6 @@ dev = [
4142
"breathe>=4.36.0,<5",
4243
]
4344

44-
45-
46-
4745
[build-system]
4846
requires = ["hatchling"]
4947
build-backend = "hatchling.build"

uv.lock

Lines changed: 9 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)