clear-skies-doc-builder 2.0.7__py3-none-any.whl → 2.0.8__py3-none-any.whl

{clear_skies_doc_builder-2.0.7.dist-info → clear_skies_doc_builder-2.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-doc-builder
-Version: 2.0.7
+Version: 2.0.8
 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
@@ -142,6 +142,38 @@ This creates:
 
 The `grand_parent` field enables the Jekyll "just-the-docs" theme's three-level navigation, allowing you to document submodule classes under their logical grouping.
 
+#### Parent-Only Sections (No Classes)
+
+You can create a parent section that only serves as a navigation container without documenting any classes directly. This is useful when you want to group multiple submodules under a common heading:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.Module"
+    },
+    {
+      "title": "IAM Cursors",
+      "source": "clearskies.cursors.iam.IamCursor",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "parent": "Cursors",
+      "classes": ["clearskies.cursors.iam.RdsMysql"]
+    },
+    {
+      "title": "Port Forwarding",
+      "source": "clearskies.cursors.port_forwarding.PortForwarder",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "parent": "Cursors",
+      "classes": ["clearskies.cursors.port_forwarding.Ssm"]
+    }
+  ]
+}
+```
+
+Note that the "Cursors" entry has no `classes` field - it just creates an index page with the overview from the source class docblock. The child sections ("IAM Cursors" and "Port Forwarding") will appear as sub-navigation items under "Cursors".
+
 #### Using SingleClass for Individual Classes
 
 You can also use `SingleClass` builder for documenting individual classes within a hierarchy:

{clear_skies_doc_builder-2.0.7.dist-info → clear_skies_doc_builder-2.0.8.dist-info}/RECORD

@@ -8,7 +8,7 @@ clearskies_doc_builder/backends/module_backend.py,sha256=hHJXt00TJIF3-69p_kjdAZu
 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=WlLSMPN3AoCaMg66DxvRXiO3x4zVFhoYGXjHM6U0M6c,4912
+clearskies_doc_builder/builders/module.py,sha256=tPtXcqmI-XG-yH82WdmK4MLBL73RMiAHL_0VOJZaIKw,4920
 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.7.dist-info/METADATA,sha256=vOVE5Aqo5BiuVRm3QdwiE5FHfelXSRvRS_2OfKkwo_A,7036
-clear_skies_doc_builder-2.0.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-clear_skies_doc_builder-2.0.7.dist-info/licenses/LICENSE,sha256=pgH32-xrgpIDf6WIBUA1X19o-sIHIXgToCxo-tBWDdw,1071
-clear_skies_doc_builder-2.0.7.dist-info/RECORD,,
+clear_skies_doc_builder-2.0.8.dist-info/METADATA,sha256=0FnkQRgfk8cDjVAC3T8uak55otGw8h5jgB_eG84gmkY,8191
+clear_skies_doc_builder-2.0.8.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+clear_skies_doc_builder-2.0.8.dist-info/licenses/LICENSE,sha256=pgH32-xrgpIDf6WIBUA1X19o-sIHIXgToCxo-tBWDdw,1071
+clear_skies_doc_builder-2.0.8.dist-info/RECORD,,

clearskies_doc_builder/builders/module.py

@@ -9,7 +9,7 @@ from .builder import Builder
 class Module(Builder):
     def __init__(self, branch, modules, classes, doc_root, nav_order):
         super().__init__(branch, modules, classes, doc_root, nav_order)
-        self.class_list = branch["classes"]
+        self.class_list = branch.get("classes", [])
         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)