deterministic module order (#12)

Author: anakin87

src/haystack_pydoc_tools/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present deepset GmbH <[email protected]>
 #
 # SPDX-License-Identifier: Apache-2.0
-__version__ = "0.6.2"
+__version__ = "0.6.3"

src/haystack_pydoc_tools/loaders.py

@@ -12,9 +12,10 @@ def load(self) -> t.Iterable[docspec.Module]:
         Load the modules, but include inherited methods in the classes.
         """
         # Load all haystack modules
+        # Sort by module name to ensure deterministic ordering across different filesystems
         temp_loader = PythonLoader(search_path=["../../../haystack"])
         temp_loader.init(Context(directory="."))
-        all_modules = list(temp_loader.load())
+        all_modules = sorted(temp_loader.load(), key=lambda m: m.name)
 
         # Collect all classes
         classes = {}
@@ -24,7 +25,8 @@ def load(self) -> t.Iterable[docspec.Module]:
                     classes[member.name] = member
 
         # Load the modules specified in the search path
-        modules = super().load()
+        # Sort by module name to ensure deterministic ordering across different filesystems
+        modules = sorted(super().load(), key=lambda m: m.name)
 
         # Add inherited methods to the classes
         modules = self.include_inherited_methods(modules, classes)