]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Pin Sphinx related package versions to match ReadTheDocs and our CI
authorPetr Špaček <pspacek@isc.org>
Wed, 27 Apr 2022 06:51:41 +0000 (08:51 +0200)
committerPetr Špaček <pspacek@isc.org>
Wed, 27 Apr 2022 12:33:45 +0000 (14:33 +0200)
This seems to be most appropriate way to ensure consistency between
release tarballs and public presentation on ReadTheDocs.

Previous attempt with removing docutils constraint, which relied on pip
depedency solver to pick the same packages as in CI was flawed. RTD
installs a bit different set of packages so it was inherently
unreliable.

As a result RTD pulled in sphinx-rtd-theme==0.4.3 while CI
had 1.0.0, and this inconsistency caused Table of Contents in Release
Notes to render incorrectly. Previous solution was to downgrade
docutils to < 0.17, but I think we should rather pin exact versions.

For the long history of messing with versions read also
isc-projects/bind9@2a8eda0084fbdd34af8071fe586c8ed50af87f11
isc-projects/images@d4435b97be70c2a3a6f8b570ef0dcb616c3dc4ae
isc-projects/bind9@6a2daddf5b95375668945801f636c8335e300fb5

doc/arm/requirements.txt

index bf5cf6620df406a3d1fa8f31e9104441b21ec0d3..e9ea383a8cfa7c26e23b48a56212fe26a5f736cc 100644 (file)
@@ -1 +1,5 @@
-Sphinx>=2
+# Make Read the Docs use the exact same package versions as in
+# registry.gitlab.isc.org/isc-projects/images/bind9:debian-bullseye-amd64
+Sphinx==4.5.0
+docutils==0.17.1
+sphinx_rtd_theme==1.0.0