Move methods into class pages for docs (#563)

qiskit-community · Oct 13, 2023 · cddfbbb · cddfbbb
1 parent d6cb5fc
commit cddfbbb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 12 deletions.
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -18,11 +18,9 @@
 
    .. rubric:: Attributes
 
-   .. autosummary::
-      :toctree: ../stubs/
    {% for item in all_attributes %}
       {%- if not item.startswith('_') %}
-          ~{{ name }}.{{ item }}
+   .. autoattribute:: {{ name }}.{{ item }}
       {%- endif -%}
    {%- endfor %}
    {% endif %}
@@ -33,11 +31,9 @@
 
    .. rubric:: Methods
 
-   .. autosummary::
-      :toctree: ../stubs/
    {% for item in all_methods %}
       {%- if not item.startswith('_') %}
-          ~{{ name }}.{{ item }}
+   .. automethod:: {{ name }}.{{ item }}
       {%- endif -%}
    {%- endfor %}
 

diff --git a/docs/_templates/autosummary/class_no_inherited_members.rst b/docs/_templates/autosummary/class_no_inherited_members.rst
@@ -18,12 +18,10 @@
 
    .. rubric:: Attributes
 
-   .. autosummary::
-      :toctree: ../stubs/
    {% for item in all_attributes %}
       {%- if item not in inherited_members %}
         {%- if not item.startswith('_') %}
-            ~{{ name }}.{{ item }}
+   .. autoattribute:: {{ name }}.{{ item }}
         {%- endif -%}
       {%- endif %}
    {%- endfor %}
@@ -35,12 +33,10 @@
 
    .. rubric:: Methods
 
-   .. autosummary::
-      :toctree: ../stubs/
    {% for item in all_methods %}
       {%- if item not in inherited_members %}
         {%- if not item.startswith('_') %}
-            ~{{ name }}.{{ item }}
+   .. automethod:: {{ name }}.{{ item }}
         {%- endif -%}
       {%- endif %}
    {%- endfor %}