[experiment] Change autosummary template

example_docs/docs/_templates/autosummary/class.rst

@@ -1,6 +1,5 @@
 {#
-   The general principle of this is that we manually document attributes here in
-   the same file, but give all methods their own page.  By default, we document
+   We show all the class's methods and attributes on the same page. By default, we document
    all methods, including those defined by parent classes.
 -#}
 
@@ -9,33 +8,24 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
-{#-
-   Avoid having autodoc populate the class with the members we're about to
-   summarize to avoid duplication.
-#}
    :no-members:
    :show-inheritance:
-{#
-   Methods all get their own separate page, with their names and the first lines
-   of their docstrings tabulated.  The documentation from `__init__` is
-   automatically included in the standard class documentation, so we don't want
-   to repeat it.
--#}
-{% block methods_summary %}{% set wanted_methods = (methods | reject('==', '__init__') | list) %}{% if wanted_methods %}
-   .. rubric:: Methods
 
-   .. autosummary::
-      :nosignatures:
-      :toctree: ../stubs/
-{% for item in wanted_methods %}
-      ~{{ name }}.{{ item }}
-{%- endfor %}
-{% endif %}{% endblock %}
-
-{% block attributes_summary %}{% if attributes %}
+{% block attributes_summary %}
+  {% if attributes %}
    .. rubric:: Attributes
-{# Attributes should all be summarized directly on the same page. -#}
-{% for item in attributes %}
+    {% for item in attributes %}
    .. autoattribute:: {{ item }}
-{%- endfor %}
-{% endif %}{% endblock -%}
+    {%- endfor %}
+  {% endif %}
+{% endblock -%}
+
+{% block methods_summary %}
+  {% set wanted_methods = (methods | reject('==', '__init__') | list) %}
+  {% if wanted_methods %}
+   .. rubric:: Methods
+    {% for item in wanted_methods %}
+   .. automethod:: {{ item }}
+    {%- endfor %}
+  {% endif %}
+{% endblock %}

example_docs/docs/_templates/autosummary/class_no_inherited_members.rst

@@ -1,38 +1,28 @@
-{#
-   This is very similar to the default class template, except this one is used
-   when we don't want to generate any inherited methods.
--#}
+{# This is identical to class.rst, except for the filtering in `set wanted_methods`. -#}
 
 {{ objname | escape | underline }}
 
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
-{#-
-   Avoid having autodoc populate the class with the members we're about to
-   summarize to avoid duplication.
-#}
    :no-members:
    :show-inheritance:
-{#
-   Methods all get their own separate page, with their names and the first lines
-   of their docstrings tabulated.
--#}
-{% block methods_summary %}{% set wanted_methods = (methods | reject('in', inherited_members) | reject('==', '__init__') | list) %}{% if wanted_methods %}
-   .. rubric:: Methods Defined Here
 
-   .. autosummary::
-      :nosignatures:
-      :toctree: ../stubs/
-{% for item in wanted_methods %}
-      ~{{ name }}.{{ item }}
-{%- endfor %}
-{% endif %}{% endblock %}
-
-{% block attributes_summary %}{% if attributes %}
+{% block attributes_summary %}
+  {% if attributes %}
    .. rubric:: Attributes
-{# Attributes should all be summarized directly on the same page. -#}
-{% for item in attributes %}
+    {% for item in attributes %}
    .. autoattribute:: {{ item }}
-{%- endfor %}
-{% endif %}{% endblock -%}
+    {%- endfor %}
+  {% endif %}
+{% endblock -%}
+
+{% block methods_summary %}
+  {% set wanted_methods = (methods | reject('in', inherited_members) | reject('==', '__init__') | list) %}
+  {% if wanted_methods %}
+   .. rubric:: Methods
+    {% for item in wanted_methods %}
+   .. automethod:: {{ item }}
+    {%- endfor %}
+  {% endif %}
+{% endblock %}

tests/js/qiskit.test.js

@@ -227,17 +227,6 @@ test.describe("api docs", () => {
     await expect(content).toHaveScreenshot();
   });
 
-  test("method page", async ({ page }) => {
-    await page.goto("stubs/api_example.Electron.compute_momentum.html");
-    const content = page.locator("div.article-container");
-    await expect(content).toHaveScreenshot();
-
-    // Also test a method with @typing.overload.
-    await page.goto("stubs/api_example.Electron.overloaded_func.html");
-    const content2 = page.locator("div.article-container");
-    await expect(content2).toHaveScreenshot();
-  });
-
   test("function page", async ({ page }) => {
     await page.goto("stubs/api_example.my_function.html");
     const content = page.locator("div.article-container");