Second attempt

BQSKit · Aug 31, 2024 · d1b9c38 · d1b9c38
1 parent 38e5236
commit d1b9c38
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,6 +38,7 @@
     'myst_parser',
     'jupyter_sphinx',
     'nbsphinx',
+    'sphinx_autodoc_typehints',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -75,8 +76,8 @@
 #     'IntervalLike': 'bqskit.ir.IntervalLike',
 # }
 # napoleon_type_aliases = autodoc_type_aliases
-autodoc_typehints = 'both'
-autodoc_typehints_description_target = 'all'
+autodoc_typehints = 'description'
+autodoc_typehints_description_target = 'documented'
 autoclass_content = 'class'
 nbsphinx_output_prompt = 'Out[%s]:'
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,7 @@ Sphinx>=4.5.0
 sphinx-autodoc-typehints>=1.12.0
 sphinx-rtd-theme>=1.0.0
 sphinx-togglebutton>=0.2.3
+sphinx-autodoc-typehints>=2.3.0
 sphinxcontrib-applehelp>=1.0.2
 sphinxcontrib-devhelp>=1.0.2
 sphinxcontrib-htmlhelp>=2.0.0