docs: prevent build error by rolling back Sphinx version

We're hitting a sphinxcontrib-httpdomain vs sphinx issue that was
causing the openapi part of doc builds to error out with:

<openapi>:1:Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.

See https://github.com/sphinx-contrib/httpdomain/pull/51

Until it's fixed, hold back the Sphinx version to < 4.1.0

Signed-off-by: Daniel Axtens <dja@axtens.net>
Reviewed-by: Stephen Finucane <stephen@that.guru>

diff --git a/docs/requirements.txt b/docs/requirements.txt
index e2641c8fb996926ebf6803cc793a6bac9706a34e..b60bca53215fce3f21c1844877fcb9ea98f556ec 100644 (file)
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,6 @@
-sphinx>=2.0
+# sphinx 4.1.x breaks sphinxcontrib-httpdomain which sphinxcontrib-openapi depends on
+# see https://github.com/sphinx-contrib/httpdomain/pull/51
+sphinx>=2.0,<4.1
 reno>=2.2
 sphinx_rtd_theme~=0.5.0
 jinja2~=2.11.2