clear-skies-doc-builder 2.0.7__tar.gz → 2.0.8__tar.gz

{clear_skies_doc_builder-2.0.7 → clear_skies_doc_builder-2.0.8}/CHANGELOG.md

@@ -5,11 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.8] - 2026-01-28
+
+### Added
+- Add support for just headings
+
 ## [2.0.7] - 2026-01-28
 
 ### Added
 - Add multi hierarchy
 
+### Changed
+- Bump version to v2.0.7 by @github-actions[bot]
+
 ## [2.0.6] - 2026-01-28
 
 ### Added
@@ -75,6 +83,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * @ made their first contribution
 * @tnijboer made their first contribution in [#1](https://github.com/clearskies-py/doc-builder/pull/1)
 * @cmancone made their first contribution
+[2.0.8]: https://github.com/clearskies-py/doc-builder/compare/v2.0.7..v2.0.8
 [2.0.7]: https://github.com/clearskies-py/doc-builder/compare/v2.0.6..v2.0.7
 [2.0.6]: https://github.com/clearskies-py/doc-builder/compare/v2.0.5..v2.0.6
 [2.0.5]: https://github.com/clearskies-py/doc-builder/compare/v2.0.4..v2.0.5

clear_skies_doc_builder-2.0.8/LATEST_CHANGELOG.md

@@ -0,0 +1,5 @@
+## [2.0.8] - 2026-01-28
+
+### Added
+- Add support for just headings
+

{clear_skies_doc_builder-2.0.7 → clear_skies_doc_builder-2.0.8}/PKG-INFO

@@ -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 → clear_skies_doc_builder-2.0.8}/README.md

@@ -122,6 +122,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 → clear_skies_doc_builder-2.0.8}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "clear-skies-doc-builder"
 description = "The docbuilder for all 'official' clearskies plugins (as well as the main clearskies docs)"
-version = "2.0.7"
+version = "2.0.8"
 license = "MIT"
 readme = "./README.md"
 authors = [{name = "Conor Mancone", email = "cmancone@gmail.com"}]

{clear_skies_doc_builder-2.0.7 → clear_skies_doc_builder-2.0.8}/src/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)

{clear_skies_doc_builder-2.0.7 → clear_skies_doc_builder-2.0.8}/uv.lock

@@ -146,7 +146,7 @@ wheels = [
 
 [[package]]
 name = "clear-skies-doc-builder"
-version = "2.0.7"
+version = "2.0.8"
 source = { editable = "." }
 dependencies = [
     { name = "clear-skies" },

clear_skies_doc_builder-2.0.7/LATEST_CHANGELOG.md

@@ -1,5 +0,0 @@
-## [2.0.7] - 2026-01-28
-
-### Added
-- Add multi hierarchy
-