clear-skies-doc-builder 2.0.10__py3-none-any.whl → 2.0.12__py3-none-any.whl

{clear_skies_doc_builder-2.0.10.dist-info → clear_skies_doc_builder-2.0.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-doc-builder
-Version: 2.0.10
+Version: 2.0.12
 Summary: The docbuilder for all 'official' clearskies plugins (as well as the main clearskies docs)
 Project-URL: repository, https://github.com/clearskies-py/docs
 Project-URL: issues, https://github.com/clearskies-py/docs/issues

{clear_skies_doc_builder-2.0.10.dist-info → clear_skies_doc_builder-2.0.12.dist-info}/RECORD

@@ -1,14 +1,14 @@
 clearskies_doc_builder/__init__.py,sha256=AFQzZ9HwIxPyLpsUhkSDRh_6hm8-5H4RpAelTShCDTc,1300
-clearskies_doc_builder/build_callable.py,sha256=DjPGTXD9mwwhCzTFSVcEPOHAU4Nn6yWjPf8ZJQBn-WQ,3758
+clearskies_doc_builder/build_callable.py,sha256=UYbWACdDpfG8sLGg0Dhu-KEhsitSXdYqn5je6wr6E6o,4676
 clearskies_doc_builder/prepare_doc_space.py,sha256=BXIH-CQJ1ZY6sf2bj1Fjhrglihls6AnqMNdjirDqSFM,1019
 clearskies_doc_builder/backends/__init__.py,sha256=q5jpy8xfZ4SbGQ1T30q4mp4h346HaMivvmNqtgTMQxw,303
 clearskies_doc_builder/backends/attribute_backend.py,sha256=2nivmJpedPsoQibf9NlIT-Wfvg0PbfHKoT06xKkt0O0,3634
 clearskies_doc_builder/backends/class_backend.py,sha256=JIKRYAVFxYEOHV7tG9RBrfuo1SN8Uw4KKaMz5YzlMHo,4112
-clearskies_doc_builder/backends/module_backend.py,sha256=hHJXt00TJIF3-69p_kjdAZuWOyGhpCvD3TgOKMOp4og,5971
+clearskies_doc_builder/backends/module_backend.py,sha256=haOJ1RV9I0GnprFvPKqVM7aqqChPQrf6DnFwinwjINU,6199
 clearskies_doc_builder/backends/python.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clearskies_doc_builder/builders/__init__.py,sha256=ndAK4-imR9vhl7CS425ASYi46FN5-eR9Dr6bKxCn5lA,292
 clearskies_doc_builder/builders/builder.py,sha256=2QZDscwOZ4vfx4NzFU4AyKgAPuKVU0jsYBcT42CZgzY,7957
-clearskies_doc_builder/builders/module.py,sha256=tPtXcqmI-XG-yH82WdmK4MLBL73RMiAHL_0VOJZaIKw,4920
+clearskies_doc_builder/builders/module.py,sha256=KCAVYO6RbYqbn_6uIIQqG4LLLpRYIMg20K2EmZYy2x4,5349
 clearskies_doc_builder/builders/single_class.py,sha256=-3b9VC_bxB9r5EHcdUCA1VFWxY0r_N72td0ZHLydy3Y,4846
 clearskies_doc_builder/builders/single_class_to_section.py,sha256=uEyawxW4cIdavBVnK2TBiIqywUgj3IxmUcS16E81cgI,1754
 clearskies_doc_builder/columns/__init__.py,sha256=--cof8kFPwlZncM3MBQYkvfq8TejEeI0B99vTlEVCkU,566
@@ -32,7 +32,7 @@ clearskies_doc_builder/models/method_reference.py,sha256=U4YOpRLotyEp6G0Y5OHORdo
 clearskies_doc_builder/models/module.py,sha256=5JUF2LUKTpVsYlviT7T_qgLdMApGtS4qIUloCEzJ-uo,573
 clearskies_doc_builder/models/module_reference.py,sha256=-zHnrkP6JR7j2XFuW94uGlPENI3ZshxgBu4yY9ayzSg,177
 clearskies_doc_builder/models/property.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clear_skies_doc_builder-2.0.10.dist-info/METADATA,sha256=wPQb8k_LQxqO6DwVomojU3qMQeVAKhGZ5WPWqtJIrz0,10627
-clear_skies_doc_builder-2.0.10.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-clear_skies_doc_builder-2.0.10.dist-info/licenses/LICENSE,sha256=pgH32-xrgpIDf6WIBUA1X19o-sIHIXgToCxo-tBWDdw,1071
-clear_skies_doc_builder-2.0.10.dist-info/RECORD,,
+clear_skies_doc_builder-2.0.12.dist-info/METADATA,sha256=BrxKcMZZ5mBoA4zKjfsKxivIeOUrmix1xLpI7tuy0pU,10627
+clear_skies_doc_builder-2.0.12.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+clear_skies_doc_builder-2.0.12.dist-info/licenses/LICENSE,sha256=pgH32-xrgpIDf6WIBUA1X19o-sIHIXgToCxo-tBWDdw,1071
+clear_skies_doc_builder-2.0.12.dist-info/RECORD,,

clearskies_doc_builder/backends/module_backend.py

@@ -9,6 +9,7 @@ import clearskies.model
 import clearskies.query
 from clearskies.autodoc.schema import Integer as AutoDocInteger
 from clearskies.autodoc.schema import Schema as AutoDocSchema
+from clearskies.configs import Boolean
 from clearskies.query.result import CountQueryResult, RecordQueryResult, RecordsQueryResult, SuccessQueryResult
 
 
@@ -20,17 +21,22 @@ class ModuleBackend(clearskies.backends.Backend):
         "module": lambda module, value: id(module) == id(value),
     }
 
+    can_create = Boolean(default=False)
+    can_update = Boolean(default=False)
+    can_delete = Boolean(default=False)
+    can_query = Boolean(default=True)
+
     def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> RecordQueryResult:
         """Update the record with the given id with the information from the data dictionary."""
-        raise Exception(f"The {self.__class__.__name__} only supports read operations: update is not allowed")
+        raise NotImplementedError(f"The {self.__class__.__name__} only supports read operations: update is not allowed")
 
     def create(self, data: dict[str, Any], model: clearskies.model.Model) -> RecordQueryResult:
         """Create a record with the information from the data dictionary."""
-        raise Exception(f"The {self.__class__.__name__} only supports read operations: create is not allowed")
+        raise NotImplementedError(f"The {self.__class__.__name__} only supports read operations: create is not allowed")
 
     def delete(self, id: int | str, model: clearskies.model.Model) -> SuccessQueryResult:
         """Delete the record with the given id."""
-        raise Exception(f"The {self.__class__.__name__} only supports read operations: delete is not allowed")
+        raise NotImplementedError(f"The {self.__class__.__name__} only supports read operations: delete is not allowed")
 
     def count(self, query: clearskies.query.Query) -> CountQueryResult:
         """Return the number of records which match the given query configuration."""

clearskies_doc_builder/build_callable.py

@@ -48,11 +48,15 @@ def _sort_key_for_entry(entry: dict[str, Any]) -> tuple[int, str]:
     return (type_priority, title)
 
 
-def _compute_nav_orders(tree: list[dict[str, Any]]) -> dict[int, int]:
+def _compute_nav_orders_and_child_counts(
+    tree: list[dict[str, Any]],
+) -> tuple[dict[int, int], dict[str, int]]:
     """
-    Compute nav_order for each entry in the tree based on sorting rules.
+    Compute nav_order for each entry and count children per parent.
 
-    Returns a dict mapping original tree index to computed nav_order.
+    Returns:
+        - nav_orders: dict mapping original tree index to computed nav_order
+        - child_counts: dict mapping parent title to number of child entries
 
     For entries with the same parent:
     - Groups by entry_type (submodules first, then classes)
@@ -60,6 +64,9 @@ def _compute_nav_orders(tree: list[dict[str, Any]]) -> dict[int, int]:
     - Assigns sequential nav_order values
 
     Top-level entries maintain their original order (index + 2).
+
+    The child_counts is used by Module builders to offset their internal class
+    nav_orders so that child entries (submodules) appear first in navigation.
     """
     # Group entries by their parent
     parent_groups: dict[str | None, list[tuple[int, dict[str, Any]]]] = {}
@@ -72,6 +79,7 @@ def _compute_nav_orders(tree: list[dict[str, Any]]) -> dict[int, int]:
 
     # Compute nav_order for each entry
     nav_orders: dict[int, int] = {}
+    child_counts: dict[str, int] = {}
 
     for parent, entries in parent_groups.items():
         if parent is None:
@@ -84,21 +92,34 @@ def _compute_nav_orders(tree: list[dict[str, Any]]) -> dict[int, int]:
             for nav_order, (original_index, entry) in enumerate(sorted_entries, start=1):
                 nav_orders[original_index] = nav_order
 
-    return nav_orders
+    # Count children for each parent (by title)
+    for entry in tree:
+        parent = entry.get("parent")
+        if parent:
+            child_counts[parent] = child_counts.get(parent, 0) + 1
+
+    return nav_orders, child_counts
 
 
 def build_callable(modules: models.Module, classes: models.Class, config: dict[str, Any], project_root: str):
     doc_root = prepare_doc_space(project_root)
 
-    # Pre-compute nav_orders based on sorting rules
-    nav_orders = _compute_nav_orders(config["tree"])
+    # Pre-compute nav_orders and child counts based on sorting rules
+    nav_orders, child_counts = _compute_nav_orders_and_child_counts(config["tree"])
 
     for index, branch in enumerate(config["tree"]):
         nav_order = nav_orders[index]
 
+        # Add child_entry_count to branch so Module builder can offset its class nav_orders
+        # This ensures child entries (submodules) appear first in navigation
+        branch_with_child_count = {
+            **branch,
+            "child_entry_count": child_counts.get(branch["title"], 0),
+        }
+
         builder_class = classes.find("import_path=" + branch["builder"]).type
         builder = builder_class(
-            branch,
+            branch_with_child_count,
             modules,
             classes,
             doc_root,

clearskies_doc_builder/builders/module.py

@@ -13,6 +13,9 @@ class Module(Builder):
         self.args_to_additional_attributes_map = branch.get("args_to_additional_attributes_map", {})
         self.parent = branch.get("parent", False)
         self.grand_parent = branch.get("grand_parent", False)
+        # Number of child entries (submodules) under this module in the config tree
+        # Used to offset class nav_orders so child entries appear first in navigation
+        self.child_entry_count = branch.get("child_entry_count", 0)
 
     def build(self):
         title_snake_case = clearskies.functional.string.title_case_to_snake_case(self.title.replace(" ", "")).replace(
@@ -51,7 +54,9 @@ class Module(Builder):
 
         default_args = self.default_args()
 
-        nav_order = 0
+        # Start nav_order after any child entries (submodules) so they appear first
+        # Child entries get nav_order 1, 2, 3... and classes get nav_order after that
+        nav_order = self.child_entry_count
         for class_name in self.class_list:
             nav_order += 1
             source_class = self.classes.find(f"import_path={class_name}")