Always show type hints in docs (#24)

(cherry picked from commit 1b13a66)
Qiskit · Nov 7, 2024 · 4d3eb66 · 4d3eb66
1 parent 910a985
commit 4d3eb66
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 8 deletions.
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -10,6 +10,7 @@
 .. autoclass:: {{ objname }}
    :no-members:
    :no-inherited-members:
+   :no-special-members:
    :show-inheritance:
 
 {% block attributes_summary %}

diff --git a/docs/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -74,16 +74,16 @@
 .. |version| replace:: {release}
 """
 
-# Options for autodoc. These reflect the values from Terra.
+# Options for autodoc. These reflect the values from Qiskit SDK and Runtime.
 autosummary_generate = True
 autosummary_generate_overwrite = False
 autoclass_content = "both"
 autodoc_typehints = "description"
-autodoc_typehints_description_target = "documented_params"
-autodoc_member_order = "bysource"
 autodoc_default_options = {
     "inherited-members": None,
 }
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
 
 
 # This adds numbers to the captions for figures, tables,