From 261858d8e2a0d92c91a89044dbc9bc9f58135277 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:56:14 -0500 Subject: [PATCH] Always show type hints in docs (#96) (cherry picked from commit 7ad5457367ffb7ad62a271f7cb0d5e833709ea2d) --- docs/_templates/autosummary/class.rst | 1 + docs/conf.py | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst index a2481c8..175b08f 100644 --- 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/conf.py b/docs/conf.py index 0854e3f..5a30145 100644 --- 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,