fix: fix sorting of modules (#7)

src/mkdocs_api_autonav/plugin.py

@@ -191,7 +191,7 @@ def _iter_modules(
     path where the corresponding documentation file should be written.
     """
     root_module = Path(root_module)
-    for abs_path in _iter_py_files(root_module, on_implicit_namespace_packge):
+    for abs_path in sorted(_iter_py_files(root_module, on_implicit_namespace_packge)):
         rel_path = abs_path.relative_to(root_module.parent)
         doc_path = rel_path.with_suffix(".md")
         full_doc_path = Path(docs_root, doc_path)

tests/test_mkdocs_api_autonav.py

@@ -9,7 +9,7 @@
 from mkdocs.exceptions import Abort
 from pytest import MonkeyPatch
 
-from mkdocs_api_autonav.plugin import PluginConfig
+from mkdocs_api_autonav.plugin import PluginConfig, _iter_modules
 
 if TYPE_CHECKING:
     from _pytest.logging import LogCaptureFixture
@@ -67,6 +67,24 @@ def test_build(repo1: Path) -> None:
     assert (sub_sub / "index.html").is_file()
 
 
+def test_sorting(repo1: Path) -> None:
+    package = repo1 / "src" / "my_library"
+    (package / "z_submod.py").touch()
+    (package / "a_submod.py").touch()
+    modules = [
+        x
+        for x, *_ in _iter_modules(repo1 / "src" / "my_library", str(repo1), "skip")
+        if not any(part.startswith("_") for part in x)
+    ]
+    assert modules == [
+        ("my_library",),
+        ("my_library", "a_submod"),
+        ("my_library", "submod"),
+        ("my_library", "submod", "sub_submod"),
+        ("my_library", "z_submod"),
+    ]
+
+
 def test_build_without_mkdocstrings(repo1: Path, caplog: LogCaptureFixture) -> None:
     cfg = cfg_dict()
     cfg["plugins"].remove({"mkdocstrings": {}})