| Message ID | 20210823064859.2984959-1-dja@axtens.net |
|---|---|
| State | Accepted |
| Headers | show |
| Series | docs: prevent build error by rolling back Sphinx version | expand |
On Mon, 2021-08-23 at 16:48 +1000, Daniel Axtens wrote: > 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> Unfortunate but necessary. The gate for sphinx-contrib/httpdomain is pretty badly broken right now so it could be a while before that patch lands :-( Reviewed-by: Stephen Finucane <stephen@that.guru> ...and applied. Stephen
diff --git a/docs/requirements.txt b/docs/requirements.txt index e2641c8fb996..b60bca53215f 100644 --- 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
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> --- docs/requirements.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)