feat: fix toctree in class.rst and avoid nested objects

Author: jorgepiloto

autoapi/templates/python/class.rst

@@ -37,30 +37,66 @@
    {% set visible_classes = obj.classes|rejectattr("inherited")|selectattr("display")|list %}
    {% endif %}
    {% for klass in visible_classes %}
-   {{ klass.render()|indent(3) }}
+   {{ klass.render(own_page_types=[])|indent(3) }}
    {% endfor %}
    {% if "inherited-members" in autoapi_options %}
    {% set visible_properties = obj.properties|selectattr("display")|list %}
    {% else %}
    {% set visible_properties = obj.properties|rejectattr("inherited")|selectattr("display")|list %}
    {% endif %}
+   {% if "property" in own_page_types and visible_properties %}
+   Properties
+   ----------
+
+   .. toctree::
+      :hidden:
+
+      {% for property in visible_properties %}
+      {{ property.name }}.rst
+      {% endfor %}
+   {% else %}
    {% for property in visible_properties %}
    {{ property.render()|indent(3) }}
    {% endfor %}
+   {% endif %}
    {% if "inherited-members" in autoapi_options %}
    {% set visible_attributes = obj.attributes|selectattr("display")|list %}
    {% else %}
    {% set visible_attributes = obj.attributes|rejectattr("inherited")|selectattr("display")|list %}
    {% endif %}
+   {% if "attribute" in own_page_types and visible_attributes %}
+   Attributes
+   ----------
+
+   .. toctree::
+      :hidden:
+
+      {% for attribute in visible_attributes %}
+      {{ attribute.name }}.rst
+      {% endfor %}
+   {% else %}
    {% for attribute in visible_attributes %}
    {{ attribute.render()|indent(3) }}
    {% endfor %}
+   {% endif %}
    {% if "inherited-members" in autoapi_options %}
    {% set visible_methods = obj.methods|selectattr("display")|list %}
    {% else %}
    {% set visible_methods = obj.methods|rejectattr("inherited")|selectattr("display")|list %}
    {% endif %}
+   {% if "method" in own_page_types and visible_methods %}
+   Methods
+   -------
+
+   .. toctree::
+      :hidden:
+
+      {% for method in visible_methods %}
+      {{ method.name }}.rst
+      {% endfor %}
+   {% else %}
    {% for method in visible_methods %}
    {{ method.render()|indent(3) }}
    {% endfor %}
+   {% endif %}
 {% endif %}

tests/python/test_pyintegration.py

@@ -1205,8 +1205,8 @@ def test_package(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        # subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        # subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents
 
@@ -1231,8 +1231,8 @@ def test_module(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        #subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        #subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents
 
@@ -1260,8 +1260,8 @@ def test_class(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        #subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        #subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents
 
@@ -1270,8 +1270,8 @@ def test_class(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        error_path = "_build/html/autoapi/example/foo/FooError.html"
-        error_file = parse(error_path)
+        #error_path = "_build/html/autoapi/example/foo/FooError.html"
+        #error_file = parse(error_path)
 
         # TODO: Look for expected contents
 
@@ -1297,8 +1297,8 @@ def test_function(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        # subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        # subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents
 
@@ -1307,17 +1307,17 @@ def test_function(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        error_path = "_build/html/autoapi/example/foo/FooError.html"
-        error_file = parse(error_path)
+        # error_path = "_build/html/autoapi/example/foo/FooError.html"
+        # error_file = parse(error_path)
 
         # TODO: Look for expected contents
 
-        foo_path = "_build/html/autoapi/example/foo/Foo.html"
+        foo_path = "_build/html/autoapi/example/foo/Foo/index.html"
         foo_file = parse(foo_path)
 
         # TODO: Look for expected contents
 
-        func_path = "_build/html/autoapi/example/foo/module_level_function.html"
+        func_path = "_build/html/autoapi/example/module_level_function.html"
         func_file = parse(func_path)
 
         # TODO: Look for expected contents
@@ -1338,8 +1338,8 @@ def test_method(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        # subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        # subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents
 
@@ -1383,8 +1383,8 @@ def test_attribute(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        # subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        # subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents
 
@@ -1438,8 +1438,8 @@ def test_data(self, builder, parse):
 
         # TODO: Look for expected contents
 
-        subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
-        subpackage_file = parse(subpackage_path)
+        # subpackage_path = "_build/html/autoapi/example/subpackage/index.html"
+        # subpackage_file = parse(subpackage_path)
 
         # TODO: Look for expected contents