Fix docs templates (#84)

qiskit-community · Oct 20, 2023 · 102f7cc · 102f7cc
1 parent 1a9edee
commit 102f7cc
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 17 deletions.
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -8,37 +8,30 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
-   :show-inheritance:
    :no-members:
    :no-inherited-members:
    :no-special-members:
+   :show-inheritance:
 
-   {% block attributes_summary %}
+{% block attributes_summary %}
    {% if attributes %}
    .. rubric:: Attributes
-   {% for item in all_attributes %}
-      {%- if not item.startswith('_') %}
+      {% for item in all_attributes %}
+         {%- if not item.startswith('_') %}
    .. autoattribute:: {{ name }}.{{ item }}
-      {%- endif -%}
-   {%- endfor %}
+         {%- endif -%}
+      {%- endfor %}
    {% endif %}
-   {% endblock %}
+{% endblock %}
 
-   {% block methods_summary %}
+{% block methods_summary %}
    {% if methods %}
    .. rubric:: Methods
    {% for item in all_methods %}
-      {%- if item not in inherited_members %}
-         {%- if not item.startswith('_') or item in ['__call__', '__mul__', '__getitem__', '__len__'] %}
-   .. automethod:: {{ name }}.{{ item }}
-         {%- endif -%}
-      {%- endif -%}
-   {%- endfor %}
-   {% for item in inherited_members %}
-      {%- if item in ['__call__', '__mul__', '__getitem__', '__len__'] %}
+      {%- if not item.startswith('_') or item in ['__call__', '__mul__', '__getitem__', '__len__'] %}
    .. automethod:: {{ name }}.{{ item }}
       {%- endif -%}
    {%- endfor %}
 
    {% endif %}
-   {% endblock %}
+{% endblock %}
diff --git a/docs/_templates/autosummary/class_no_inherited_members.rst b/docs/_templates/autosummary/class_no_inherited_members.rst
@@ -0,0 +1,41 @@
+{# This is identical to class.rst, except for the filtering of the inherited_members. -#}
+
+{% if referencefile %}
+.. include:: {{ referencefile }}
+{% endif %}
+
+{{ objname }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
+   :show-inheritance:
+
+{% block attributes_summary %}
+   {% if attributes %}
+   .. rubric:: Attributes
+      {% for item in all_attributes %}
+         {%- if not item.startswith('_') %}
+   .. autoattribute:: {{ name }}.{{ item }}
+         {%- endif -%}
+      {%- endfor %}
+   {% endif %}
+{% endblock %}
+
+{% block methods_summary %}
+   {% if methods %}
+   .. rubric:: Methods
+   {% for item in all_methods %}
+      {%- if item not in inherited_members %}
+         {%- if not item.startswith('_') or item in ['__call__', '__mul__', '__getitem__', '__len__'] %}
+   .. automethod:: {{ name }}.{{ item }}
+         {%- endif -%}
+      {%- endif -%}
+   {%- endfor %}
+
+   {% endif %}
+{% endblock %}