From 813544212e42e9b68421bb3eae0466076a8745dd Mon Sep 17 00:00:00 2001 From: Jake Lishman Date: Mon, 16 Jan 2023 12:13:09 +0000 Subject: [PATCH] Pin sphinx-autodoc-typehints The 1.21.0 release appears to have changed the spacing in its outputs, which is causing a bunch of Sphinx/docutils warnings for some of our docstrings. --- constraints.txt | 4 ++++ requirements-dev.txt | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/constraints.txt b/constraints.txt index 852c3bbc40ea..4fa28f9e31bb 100644 --- a/constraints.txt +++ b/constraints.txt @@ -1,3 +1,7 @@ # jsonschema pinning needed due nbformat==5.1.3 using deprecated behaviour in # 4.0+. The pin can be removed after nbformat is updated. jsonschema==3.2.0 + +# The 1.21.0 release of sphinx-autodoc-typehints seems to affect the spacing +# in our docstrings in a way that Sphinx doesn't like. +sphinx-autodoc-typehints==1.20.2 diff --git a/requirements-dev.txt b/requirements-dev.txt index 825fed12baba..62fac94c531d 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -18,7 +18,7 @@ seaborn>=0.9.0 reno>=3.4.0 Sphinx>=3.0.0 qiskit-sphinx-theme>=1.6 -sphinx-autodoc-typehints~=1.18,!=1.19.3 +sphinx-autodoc-typehints>=1.18 sphinx-design>=0.2.0 pygments>=2.4 scikit-learn>=0.20.0