Attempt to remove fully qualified type hints

adamjstewart · Aug 30, 2024 · ea7dd01 · ea7dd01
1 parent 6c35a50
commit ea7dd01
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -50,9 +50,8 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build']
 
-# Sphinx 3.0+ required for:
-# autodoc_typehints_description_target = "documented"
-needs_sphinx = '4.0'
+# Sphinx 4.4+ required for autodoc_typehints_format
+needs_sphinx = '4.4'
 
 nitpicky = True
 nitpick_ignore = [
@@ -106,6 +105,7 @@
 autodoc_member_order = 'bysource'
 autodoc_typehints = 'description'
 autodoc_typehints_description_target = 'documented'
+autodoc_typehints_format = 'short'
 
 # sphinx.ext.intersphinx
 intersphinx_mapping = {

diff --git a/pyproject.toml b/pyproject.toml
@@ -103,10 +103,10 @@ docs = [
     "nbsphinx>=0.8.5",
     # release versions missing files, must install from master
     "pytorch-sphinx-theme",
-    # sphinx 4+ required for autodoc_typehints_description_target = documented
+    # sphinx 4.4+ required for autodoc_typehints_format
     # sphinx 6+ is incompatible with pytorch-sphinx-theme
     # https://github.com/pytorch/pytorch_sphinx_theme/issues/175
-    "sphinx>=4,<6",
+    "sphinx>=4.4,<6",
 ]
 style = [
     # mypy 0.900+ required for pyproject.toml support