Add sphinx-build-compatibility for Read the Docs (#656)

adamchainz · web-flow · commit 17cc00657699 · 2025-06-26T14:03:06.000+01:00
This is a workaround to restore some features, like the GitHub link, until Furo updates to deal with the new RtD environment: pradyunsg/furo#795.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.extlinks",
+    "sphinx_build_compatibility.extension",
     "sphinx_copybutton",
 ]
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -60,6 +60,7 @@ test = [
 docs = [
   "furo>=2024.8.6",
   "sphinx>=7.4.7",
+  "sphinx-build-compatibility",
   "sphinx-copybutton>=0.5.2",
 ]
 
@@ -144,3 +145,6 @@ conflicts = [
     { group = "django52" },
   ],
 ]
+
+[tool.uv.sources]
+sphinx-build-compatibility = { git = "https://github.com/readthedocs/sphinx-build-compatibility" }
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`extensions = [`
`34`	`34`	`"sphinx.ext.autodoc",`
`35`	`35`	`"sphinx.ext.extlinks",`
	`36`	`+ "sphinx_build_compatibility.extension",`
`36`	`37`	`"sphinx_copybutton",`
`37`	`38`	`]`
`38`	`39`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ test = [`
`60`	`60`	`docs = [`
`61`	`61`	`"furo>=2024.8.6",`
`62`	`62`	`"sphinx>=7.4.7",`
	`63`	`+ "sphinx-build-compatibility",`
`63`	`64`	`"sphinx-copybutton>=0.5.2",`
`64`	`65`	`]`
`65`	`66`
`@@ -144,3 +145,6 @@ conflicts = [`
`144`	`145`	`{ group = "django52" },`
`145`	`146`	`],`
`146`	`147`	`]`
	`148`	`+`
	`149`	`+[tool.uv.sources]`
	`150`	`+sphinx-build-compatibility = { git = "https://github.com/readthedocs/sphinx-build-compatibility" }`