Update: add handling for .. details:: section

Author: Andrej730

src/fake_bpy_module/analyzer/directives.py

@@ -691,6 +691,26 @@ def run(self) -> list[BaseClassListNode]:
         return [base_class_list_node]
 
 
+class DetailsDirective(rst.Directive):
+    required_arguments = 0
+    optional_arguments = 1
+    final_argument_whitespace = True
+    has_content = True
+
+    def run(self) -> list[FunctionNode]:
+        # `.. details::` used in Blender docs to denote a section
+        # with dunder methods.
+        # See "Special Methods" in
+        # https://docs.blender.org/api/5.2/bmesh.types.html#bmesh.types.BMDeformVert
+        container = nodes.Element()
+        self.state.nested_parse(self.content, self.content_offset, container)
+        children = list(container.children)
+        container.children = []
+        for child in children:
+            child.parent = None
+        return children
+
+
 def register_directives() -> None:
     rst.directives.register_directive("module", ModuleDirective)
     rst.directives.register_directive("currentmodule", ModuleDirective)
@@ -715,5 +735,6 @@ def register_directives() -> None:
     rst.directives.register_directive("deprecated", DocumentDirective)
 
     rst.directives.register_directive("include", NopDirective)
+    rst.directives.register_directive("details", DetailsDirective)
 
     rst.directives.register_directive("mod-type", ModTypeDirective)

tests/python/fake_bpy_module_test/fake_bpy_module_test/analyzer_test.py

@@ -350,3 +350,16 @@ def test_generic_types(self) -> None:
         self.assertEqual(len(documents), len(rst_files))
         for doc, expect in zip(documents, expect_files, strict=True):
             self.compare_with_file_contents(doc.pformat(), expect)
+
+    def test_details_directive(self) -> None:
+        rst_files = ["details_directive.rst"]
+        expect_files = ["details_directive.xml"]
+        rst_files = [f"{self.data_dir}/input/{f}" for f in rst_files]
+        expect_files = [f"{self.data_dir}/expect/{f}" for f in expect_files]
+
+        analyzer = BaseAnalyzer()
+        documents = analyzer.analyze(rst_files)
+
+        self.assertEqual(len(documents), len(rst_files))
+        for doc, expect in zip(documents, expect_files, strict=True):
+            self.compare_with_file_contents(doc.pformat(), expect)

tests/python/fake_bpy_module_test/fake_bpy_module_test/analyzer_test_data/base_analyzer_test/expect/details_directive.xml

@@ -0,0 +1,56 @@
+<document source="<string>">
+    <source-filename>
+        details_directive.rst
+    <module>
+        <name>
+            module_1
+        <description>
+    <class>
+        <name>
+            ClassA
+        <description>
+            ClassA description
+        <base-class-list>
+        <attribute-list>
+        <function-list>
+            <function function_type="method">
+                <name>
+                    method_1
+                <description>
+                    method_1 description
+                <argument-list>
+                <return>
+                    <description>
+                        method_1 return description
+                    <data-type-list>
+                        <data-type>
+                            method_1 return type
+            <function function_type="method">
+                <name>
+                    __eq__
+                <description>
+                <argument-list>
+                    <argument argument_type="arg">
+                        <name>
+                            other
+                        <description>
+                            The other operand.
+                        <default-value>
+                        <data-type-list>
+                            <data-type>
+                                object
+                <return>
+                    <description>
+                    <data-type-list>
+                        <data-type>
+                            bool
+            <function function_type="method">
+                <name>
+                    __hash__
+                <description>
+                <argument-list>
+                <return>
+                    <description>
+                    <data-type-list>
+                        <data-type>
+                            int

tests/python/fake_bpy_module_test/fake_bpy_module_test/analyzer_test_data/base_analyzer_test/input/details_directive.rst

@@ -0,0 +1,24 @@
+.. module:: module_1
+
+.. class:: ClassA
+
+   ClassA description
+
+   .. method:: method_1()
+
+      method_1 description
+
+      :return: method_1 return description
+      :rtype: method_1 return type
+
+   .. details:: Special Methods
+
+      .. method:: __eq__(other)
+
+         :param other: The other operand.
+         :type other: object
+         :rtype: bool
+
+      .. method:: __hash__()
+
+         :rtype: int