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

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v0.0.34
+_commit: v0.0.45
 _src_path: https://github.com/clearskies-py/clearskies-module-template
 author_email: cmancone@gmail.com
 author_name: Conor Mancone

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/.github/workflows/create-version.yaml

@@ -79,7 +79,7 @@ jobs:
       # STEP 2: Commit all file changes together
       - name: Commit All Changes
         run: |
-          git add pyproject.toml CHANGELOG.md
+          git add pyproject.toml CHANGELOG.md uv.lock
           git commit -m "chore(release): bump version to ${{ steps.bump.outputs.tag }}"
 
       # STEP 3: Create the tag for the final commit

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/.github/workflows/run-tests.yml

@@ -67,7 +67,7 @@ jobs:
       python-version: ${{ matrix.python-version }}
       run-mypy: ${{ needs.changes.outputs.tests == 'true' }}
       run-pytest: ${{ needs.changes.outputs.tests == 'true' }}
-      run-black: ${{ needs.changes.outputs.tests == 'true' }}
+      run-ruff-format: ${{ needs.changes.outputs.tests == 'true' }}
       run-ruff-check: ${{ needs.changes.outputs.tests == 'true' }}
     secrets: inherit
     strategy:
@@ -76,6 +76,7 @@ jobs:
           - '3.11'
           - '3.12'
           - '3.13'
+          - '3.14'
       fail-fast: false
 
   status:

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/.github/workflows/tests-matrix.yaml

@@ -14,7 +14,7 @@ on:
       run-pytest:
         required: true
         type: boolean
-      run-black:
+      run-ruff-format:
         required: true
         type: boolean
       run-ruff-check:
@@ -66,27 +66,14 @@ jobs:
       - run: uv run pytest -v
       - run: git diff --exit-code --stat HEAD
 
-  black:
-    name: black
+  ruff-format:
+    name: ruff-format
     runs-on: ${{ inputs.runner }}
-    if: inputs.run-black
+    if: inputs.run-ruff-format
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          persist-credentials: false
-
-      - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v6
-        with:
-          python-version: ${{ inputs.python-version }}
-          enable-cache: true
-      - name: Install dependencies
-        run: uv sync --locked --all-extras --dev
-      - uses: psf/black@stable
+      - uses: astral-sh/ruff-action@v3
         with:
-          options: "--check --verbose"
-          src: "./src"
+          args: "format --diff"
 
   ruff-check:
     name: ruff-check

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/.pre-commit-config.yaml

@@ -1,5 +1,4 @@
 # Pre-commit configuration for  Akeyless Custom Producer
-fail_fast: true
 
 ci:
     autofix_commit_msg: "chore(pre-commit): autofix run"
@@ -39,12 +38,6 @@ repos:
     hooks:
       - id: uv-lock
 
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black
-        files: \.py$
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.1
     hooks:

clear_skies_doc_builder-2.0.7/.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+    "python.testing.pytestArgs": ["tests"],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "ruff.interpreter": ["${workspaceFolder}/.venv/bin/python"],
+    "ruff.path": ["${workspaceFolder}/.venv/bin/ruff"],
+    "ruff.configuration": "${workspaceFolder}/ruff.toml",
+    "ruff.nativeServer": "on",
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "mypy-type-checker.args": [
+        "--config-file=${workspaceFolder}/pyproject.toml"
+    ]
+}

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

@@ -5,9 +5,28 @@ 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.7] - 2026-01-28
+
+### Added
+- Add multi hierarchy
+
+## [2.0.6] - 2026-01-28
+
+### Added
+- Add some basic tests
+
+### Changed
+- Bump version to v2.0.6 by @github-actions[bot]
+- Update to latest copier version
+- Update dependencies
+
+### Fixed
+- Update to latest clear-skies QueryRequest
+
 ## [2.0.5] - 2025-10-16
 
 ### Changed
+- Bump version to v2.0.5 by @github-actions[bot]
 - Missing-f by @tnijboer in [#2](https://github.com/clearskies-py/doc-builder/pull/2)
 - Missing-f by @cmancone
 - Update copier
@@ -56,6 +75,8 @@ 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.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
 [2.0.4]: https://github.com/clearskies-py/doc-builder/compare/v2.0.3..v2.0.4
 [2.0.3]: https://github.com/clearskies-py/doc-builder/compare/v2.0.2..v2.0.3

clear_skies_doc_builder-2.0.7/LATEST_CHANGELOG.md

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

clear_skies_doc_builder-2.0.7/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: clear-skies-doc-builder
+Version: 2.0.7
+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
+Project-URL: changelog, https://github.com/clearskies-py/docs/blob/main/CHANGELOG.md
+Author-email: Conor Mancone <cmancone@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <4.0,>=3.11
+Requires-Dist: clear-skies<3.0.0,>=2.0.0
+Provides-Extra: dev
+Requires-Dist: types-requests>=2.32.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# docs
+
+The documentation builder for clearskies and related plugins
+
+## Overview
+
+Each "official" clearskies module (including the core clearskies library itself) has the documentation primarily written in the codebase as docblocks.  The documentation site is then built by extracting these docblocks and stitching them together.  To be clear, this isn't about the low-level "API" documentation that describes every single class/method in the framework.  Rather, this is about the primary documentation site itself (clearskies.info) which is focused on high-level use cases and examples of the primary configuration options.  As a result, it's not a simple matter of just iterating over the classes/methods and building documentation.  To build a coherent documentation site, each plugin has a configuration file that basically outlines the final "structure" or organization of the resulting documentation, as well as the name of a builder class that will combine that configuration information with the codebase itself to create the actual docs.
+
+The docs themselves (in the source code) are all written with markdown.  This documentation builder then takes that markdwon and adds the necessary headers/etc so to make them valid files for [Jekyll](https://jekyllrb.com/), the builder for the current documentation site.  The site itself is hosted in S3, so building an actual documentation site means:
+
+ 1. Properly documenting everything inside of the source code via markdown.
+ 2. Creating a config file (`docs/python/config.json`) to map source code docs to Jekyll files.
+ 3. Creating a skeleton of a Jekyll site in the `doc/jekyll` folder of the plugin.
+ 4. Installing this doc builder via `poetry add clear-skies-doc-builder`.
+ 5. Run the doc builder.
+ 6. Build with Jekyll.
+ 7. Push to the appropriate subfolder via S3.
+ 8. (Only once) Update the main clearskies doc site to know about the new subfolder for this plugin.
+
+Of course, we want the Jekyll sites to be consistent with eachother in terms of style/look.  In the long run we'll probably have this doc builder also bootstrap the Jekyll site, but for now you just have to manually setup the Jekyll build using the main clearskies repo as a template.
+
+## Configuration File Structure
+
+The `config.json` file defines the documentation structure using a tree of entries. Each entry specifies a documentation section with its source class and builder.
+
+### Basic Structure
+
+```json
+{
+  "tree": [
+    {
+      "title": "Section Title",
+      "source": "package.module.ClassName",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "classes": ["package.module.Class1", "package.module.Class2"]
+    }
+  ]
+}
+```
+
+### Nested Hierarchy (Parent/Grand-Parent)
+
+The doc builder supports up to 3 levels of navigation hierarchy using `parent` and `grand_parent` fields. This is useful for organizing documentation of submodules under a common heading.
+
+#### Two-Level Hierarchy (Parent) - Module with Classes
+
+Use this when you want to document a submodule's classes under a parent section:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "classes": [
+        "clearskies.cursors.MemoryCursor",
+        "clearskies.cursors.FileCursor"
+      ]
+    },
+    {
+      "title": "From Environment",
+      "source": "clearskies.cursors.from_environment.FromEnvironmentBase",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "parent": "Cursors",
+      "classes": [
+        "clearskies.cursors.from_environment.EnvCursor",
+        "clearskies.cursors.from_environment.SecretsCursor"
+      ]
+    }
+  ]
+}
+```
+
+This creates:
+- `docs/cursors/index.md` - Parent section with overview
+- `docs/cursors/memory-cursor.md` - Class documentation
+- `docs/cursors/file-cursor.md` - Class documentation
+- `docs/cursors/from-environment/index.md` - Submodule section with `parent: Cursors`
+- `docs/cursors/from-environment/env-cursor.md` - Class with `parent: From Environment`
+- `docs/cursors/from-environment/secrets-cursor.md` - Class with `parent: From Environment`
+
+#### Three-Level Hierarchy (Grand-Parent)
+
+For deeper nesting, use `grand_parent` to create a third level:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "classes": ["clearskies.cursors.MemoryCursor"]
+    },
+    {
+      "title": "From Environment",
+      "source": "clearskies.cursors.from_environment.FromEnvironmentBase",
+      "builder": "clearskies_doc_builder.builders.SingleClass",
+      "parent": "Cursors"
+    },
+    {
+      "title": "AWS Secrets",
+      "source": "clearskies.cursors.from_environment.aws.AWSSecretsBase",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "parent": "From Environment",
+      "grand_parent": "Cursors",
+      "classes": [
+        "clearskies.cursors.from_environment.aws.SecretsManagerCursor",
+        "clearskies.cursors.from_environment.aws.ParameterStoreCursor"
+      ]
+    }
+  ]
+}
+```
+
+This creates:
+- `docs/cursors/index.md` - Grand-parent section
+- `docs/cursors/from-environment/index.md` - Parent section with `parent: Cursors`
+- `docs/cursors/from-environment/aws-secrets/index.md` - Child section with `parent: From Environment` and `grand_parent: Cursors`
+- `docs/cursors/from-environment/aws-secrets/secrets-manager-cursor.md` - Class documentation
+
+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.
+
+#### Using SingleClass for Individual Classes
+
+You can also use `SingleClass` builder for documenting individual classes within a hierarchy:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.SingleClass"
+    },
+    {
+      "title": "Environment Cursor",
+      "source": "clearskies.cursors.from_environment.EnvironmentCursor",
+      "builder": "clearskies_doc_builder.builders.SingleClass",
+      "parent": "Cursors"
+    }
+  ]
+}
+```

clear_skies_doc_builder-2.0.7/README.md

@@ -0,0 +1,145 @@
+# docs
+
+The documentation builder for clearskies and related plugins
+
+## Overview
+
+Each "official" clearskies module (including the core clearskies library itself) has the documentation primarily written in the codebase as docblocks.  The documentation site is then built by extracting these docblocks and stitching them together.  To be clear, this isn't about the low-level "API" documentation that describes every single class/method in the framework.  Rather, this is about the primary documentation site itself (clearskies.info) which is focused on high-level use cases and examples of the primary configuration options.  As a result, it's not a simple matter of just iterating over the classes/methods and building documentation.  To build a coherent documentation site, each plugin has a configuration file that basically outlines the final "structure" or organization of the resulting documentation, as well as the name of a builder class that will combine that configuration information with the codebase itself to create the actual docs.
+
+The docs themselves (in the source code) are all written with markdown.  This documentation builder then takes that markdwon and adds the necessary headers/etc so to make them valid files for [Jekyll](https://jekyllrb.com/), the builder for the current documentation site.  The site itself is hosted in S3, so building an actual documentation site means:
+
+ 1. Properly documenting everything inside of the source code via markdown.
+ 2. Creating a config file (`docs/python/config.json`) to map source code docs to Jekyll files.
+ 3. Creating a skeleton of a Jekyll site in the `doc/jekyll` folder of the plugin.
+ 4. Installing this doc builder via `poetry add clear-skies-doc-builder`.
+ 5. Run the doc builder.
+ 6. Build with Jekyll.
+ 7. Push to the appropriate subfolder via S3.
+ 8. (Only once) Update the main clearskies doc site to know about the new subfolder for this plugin.
+
+Of course, we want the Jekyll sites to be consistent with eachother in terms of style/look.  In the long run we'll probably have this doc builder also bootstrap the Jekyll site, but for now you just have to manually setup the Jekyll build using the main clearskies repo as a template.
+
+## Configuration File Structure
+
+The `config.json` file defines the documentation structure using a tree of entries. Each entry specifies a documentation section with its source class and builder.
+
+### Basic Structure
+
+```json
+{
+  "tree": [
+    {
+      "title": "Section Title",
+      "source": "package.module.ClassName",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "classes": ["package.module.Class1", "package.module.Class2"]
+    }
+  ]
+}
+```
+
+### Nested Hierarchy (Parent/Grand-Parent)
+
+The doc builder supports up to 3 levels of navigation hierarchy using `parent` and `grand_parent` fields. This is useful for organizing documentation of submodules under a common heading.
+
+#### Two-Level Hierarchy (Parent) - Module with Classes
+
+Use this when you want to document a submodule's classes under a parent section:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "classes": [
+        "clearskies.cursors.MemoryCursor",
+        "clearskies.cursors.FileCursor"
+      ]
+    },
+    {
+      "title": "From Environment",
+      "source": "clearskies.cursors.from_environment.FromEnvironmentBase",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "parent": "Cursors",
+      "classes": [
+        "clearskies.cursors.from_environment.EnvCursor",
+        "clearskies.cursors.from_environment.SecretsCursor"
+      ]
+    }
+  ]
+}
+```
+
+This creates:
+- `docs/cursors/index.md` - Parent section with overview
+- `docs/cursors/memory-cursor.md` - Class documentation
+- `docs/cursors/file-cursor.md` - Class documentation
+- `docs/cursors/from-environment/index.md` - Submodule section with `parent: Cursors`
+- `docs/cursors/from-environment/env-cursor.md` - Class with `parent: From Environment`
+- `docs/cursors/from-environment/secrets-cursor.md` - Class with `parent: From Environment`
+
+#### Three-Level Hierarchy (Grand-Parent)
+
+For deeper nesting, use `grand_parent` to create a third level:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "classes": ["clearskies.cursors.MemoryCursor"]
+    },
+    {
+      "title": "From Environment",
+      "source": "clearskies.cursors.from_environment.FromEnvironmentBase",
+      "builder": "clearskies_doc_builder.builders.SingleClass",
+      "parent": "Cursors"
+    },
+    {
+      "title": "AWS Secrets",
+      "source": "clearskies.cursors.from_environment.aws.AWSSecretsBase",
+      "builder": "clearskies_doc_builder.builders.Module",
+      "parent": "From Environment",
+      "grand_parent": "Cursors",
+      "classes": [
+        "clearskies.cursors.from_environment.aws.SecretsManagerCursor",
+        "clearskies.cursors.from_environment.aws.ParameterStoreCursor"
+      ]
+    }
+  ]
+}
+```
+
+This creates:
+- `docs/cursors/index.md` - Grand-parent section
+- `docs/cursors/from-environment/index.md` - Parent section with `parent: Cursors`
+- `docs/cursors/from-environment/aws-secrets/index.md` - Child section with `parent: From Environment` and `grand_parent: Cursors`
+- `docs/cursors/from-environment/aws-secrets/secrets-manager-cursor.md` - Class documentation
+
+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.
+
+#### Using SingleClass for Individual Classes
+
+You can also use `SingleClass` builder for documenting individual classes within a hierarchy:
+
+```json
+{
+  "tree": [
+    {
+      "title": "Cursors",
+      "source": "clearskies.cursors.Cursor",
+      "builder": "clearskies_doc_builder.builders.SingleClass"
+    },
+    {
+      "title": "Environment Cursor",
+      "source": "clearskies.cursors.from_environment.EnvironmentCursor",
+      "builder": "clearskies_doc_builder.builders.SingleClass",
+      "parent": "Cursors"
+    }
+  ]
+}
+```

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/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.5"
+version = "2.0.7"
 license = "MIT"
 readme = "./README.md"
 authors = [{name = "Conor Mancone", email = "cmancone@gmail.com"}]

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/ruff.toml

@@ -7,7 +7,7 @@ show-fixes = true
 quote-style = "double"
 indent-style = "space"
 docstring-code-format = true
-preview = true
+preview = false
 skip-magic-trailing-comma = false
 docstring-code-line-length = 100
 line-ending = "lf"

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/src/clearskies_doc_builder/backends/attribute_backend.py

@@ -5,6 +5,7 @@ import clearskies
 import clearskies.column
 import clearskies.model
 import clearskies.query
+from clearskies.query.result import RecordsQueryResult
 
 from clearskies_doc_builder.backends.module_backend import ModuleBackend
 
@@ -18,7 +19,7 @@ class AttributeBackend(ModuleBackend):
 
     def records(
         self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
-    ) -> list[dict[str, Any]]:
+    ) -> RecordsQueryResult:
         """
         Return a list of records that match the given query configuration.
 

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/src/clearskies_doc_builder/backends/class_backend.py

@@ -7,6 +7,7 @@ import clearskies
 import clearskies.column
 import clearskies.model
 import clearskies.query
+from clearskies.query.result import RecordsQueryResult
 
 from clearskies_doc_builder.backends.module_backend import ModuleBackend
 
@@ -19,7 +20,7 @@ class ClassBackend(ModuleBackend):
 
     def records(
         self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
-    ) -> list[dict[str, Any]]:
+    ) -> RecordsQueryResult:
         """
         Return a list of records that match the given query configuration.
 
@@ -53,7 +54,7 @@ class ClassBackend(ModuleBackend):
                 raise ValueError(
                     f"I was asked to import the class named '{import_path}' but this doesn't actually reference a class"
                 )
-            return [self.unpack(Class, module)]
+            return RecordsQueryResult(records=[self.unpack(Class, module)])
 
         if "module" not in query.conditions_by_column:
             raise ValueError(

{clear_skies_doc_builder-2.0.5 → clear_skies_doc_builder-2.0.7}/src/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.query.result import CountQueryResult, RecordQueryResult, RecordsQueryResult, SuccessQueryResult
 
 
 class ModuleBackend(clearskies.backends.Backend):
@@ -19,25 +20,25 @@ class ModuleBackend(clearskies.backends.Backend):
         "module": lambda module, value: id(module) == id(value),
     }
 
-    def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+    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")
 
-    def create(self, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+    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")
 
-    def delete(self, id: int | str, model: clearskies.model.Model) -> bool:
+    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")
 
-    def count(self, query: clearskies.query.Query) -> int:
+    def count(self, query: clearskies.query.Query) -> CountQueryResult:
         """Return the number of records which match the given query configuration."""
-        return len(self.records(query))
+        return CountQueryResult(count=len(self.records(query).records))
 
     def records(
         self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
-    ) -> list[dict[str, Any]]:
+    ) -> RecordsQueryResult:
         """
         Return a list of records that match the given query configuration.
 
@@ -58,7 +59,7 @@ class ModuleBackend(clearskies.backends.Backend):
         if module_name_condition:
             module_name = module_name_condition[0].values[0]
             module = importlib.import_module(module_name)
-            return [self.unpack(module)]
+            return RecordsQueryResult(records=[self.unpack(module)])
 
         matching_modules = []
         module_names = set(sys.modules) & set(globals())
@@ -92,8 +93,8 @@ class ModuleBackend(clearskies.backends.Backend):
             "module": module,
         }
 
-    def paginate(self, records, query):
-        return records
+    def paginate(self, records, query) -> RecordsQueryResult:
+        return RecordsQueryResult(records=records)
 
     def validate_pagination_data(self, data: dict[str, Any], case_mapping: Callable) -> str:
         extra_keys = set(data.keys()) - set(self.allowed_pagination_keys())

clear_skies_doc_builder-2.0.7/src/clearskies_doc_builder/build_callable.py

@@ -0,0 +1,39 @@
+from typing import Any
+
+from clearskies_doc_builder import models
+from clearskies_doc_builder.prepare_doc_space import prepare_doc_space
+
+
+def build_callable(modules: models.Module, classes: models.Class, config: dict[str, Any], project_root: str):
+    doc_root = prepare_doc_space(project_root)
+    nav_order_parent_count: dict[str, int] = {}
+
+    for index, branch in enumerate(config["tree"]):
+        # For nav_order tracking, we need to track by the immediate parent
+        # If there's a grand_parent, the parent is the immediate container
+        # If there's only a parent, that's the immediate container
+        # If neither, it's a top-level item (doesn't need tracking)
+        parent = branch.get("parent")
+        grand_parent = branch.get("grand_parent")
+
+        # Determine nav_order based on hierarchy level
+        if parent or grand_parent:
+            # Child items: track by their immediate parent
+            nav_order_title_tracker = parent
+            if nav_order_title_tracker not in nav_order_parent_count:
+                nav_order_parent_count[nav_order_title_tracker] = 0
+            nav_order_parent_count[nav_order_title_tracker] += 1
+            nav_order = nav_order_parent_count[nav_order_title_tracker]
+        else:
+            # Top-level items: use index-based nav_order
+            nav_order = index + 2
+
+        builder_class = classes.find("import_path=" + branch["builder"]).type
+        builder = builder_class(
+            branch,
+            modules,
+            classes,
+            doc_root,
+            nav_order=nav_order,
+        )
+        builder.build()