diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst index 908a462..175b08f 100644 --- a/docs/_templates/autosummary/class.rst +++ b/docs/_templates/autosummary/class.rst @@ -10,38 +10,24 @@ .. autoclass:: {{ objname }} :no-members: :no-inherited-members: + :no-special-members: :show-inheritance: {% block attributes_summary %} - {% set wanted_attributes = (attributes | reject('in', inherited_members) | list) %} - {% if wanted_attributes %} + {% if attributes %} .. rubric:: Attributes - {% for item in wanted_attributes %} - .. autoattribute:: {{ item }} - {%- endfor %} - {% endif %} - {% set inherited_attributes = (attributes | select('in', inherited_members) | list) %} - {% if inherited_attributes %} - .. rubric:: Inherited Attributes - {% for item in inherited_attributes %} + {% for item in attributes %} .. autoattribute:: {{ item }} {%- endfor %} {% endif %} {% endblock -%} {% block methods_summary %} - {% set wanted_methods = (methods | reject('==', '__init__') | reject('in', inherited_members) | list) %} + {% set wanted_methods = (methods | reject('==', '__init__') | list) %} {% if wanted_methods %} .. rubric:: Methods {% for item in wanted_methods %} .. automethod:: {{ item }} {%- endfor %} {% endif %} - {% set inherited_methods = (methods | reject('==', '__init__') | select('in', inherited_members) | list) %} - {% if inherited_methods %} - .. rubric:: Inherited Methods - {% for item in inherited_methods %} - .. automethod:: {{ item }} - {%- endfor %} - {% endif %} {% endblock %} diff --git a/docs/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst deleted file mode 100644 index e03319b..0000000 --- a/docs/_templates/autosummary/function.rst +++ /dev/null @@ -1,5 +0,0 @@ -{{ objname | escape | underline}} - -.. currentmodule:: {{ module }} - -.. auto{{ objtype }}:: {{ objname }} diff --git a/docs/conf.py b/docs/conf.py index df865ef..70fd40c 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,