Pin sphinx-autodoc-typehints (backport #9377) (#9378)

* Pin sphinx-autodoc-typehints (#9377) 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. (cherry picked from commit 3d8a6e0) # Conflicts: # requirements-dev.txt * Fix merge conflict Co-authored-by: Jake Lishman <[email protected]>
Qiskit · Jan 16, 2023 · 13e1ff6 · 13e1ff6
1 parent 5df8db6
commit 13e1ff6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git 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
@@ -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
 jupyter-sphinx
 sphinx-design>=0.2.0
 pygments>=2.4