plating 2025-09-19
MkDocs site generated and modular package structure built out
101 files · 38,997+ · 221-

Generated MkDocs site

specify behavioral
8 files changed
  • index.html Main site page
  • search_index.json Lunr.js search index
  • sitemap.xml Site map
  • 404.html Custom 404 page
  • index.html API reference page
  • index.html Changelog page
  • index.html Configuration page
  • index.html Status page
  • Generated complete static site in site/ directory with HTML pages for all documentation sections specify internal
    3 files
    • index.html
    • 404.html
    • sitemap.xml
  • Includes Lunr.js search index, Material theme assets, and full navigation specify internal
    3 files
    • search_index.json
    • bundle.f55a23d4.min.js
    • main.e53b48f4.min.css
  • Pages cover API reference, architecture docs, bundle authoring, changelog, configuration, and status specify errata
    4 files
    • index.html
    • index.html
    • index.html
    • index.html

Modular package structure

instantiate behavioral
13 files changed
  • __init__.py Bundles subpackage init
  • base.py Bundle base class (104 lines)
  • function.py Function bundle (26 lines)
  • __init__.py Config subpackage init
  • defaults.py Default configuration values (77 lines)
  • runtime.py Runtime configuration (migrated from config.py)
  • __init__.py Discovery subpackage init
  • finder.py Component discovery finder (121 lines)
  • templates.py Template discovery (188 lines)
  • __init__.py Generation subpackage init
  • adorner.py Adorner generation (86 lines)
  • plater.py Plater generation (111 lines)
  • renderer.py Documentation renderer (58 lines)
  • Added src/plating/bundles/ subpackage with base.py (104 lines) and function.py (26 lines) for bundle abstractions instantiate internal
    2 files
    • base.py
    • function.py
  • Added src/plating/config/ subpackage with defaults.py (77 lines) and runtime.py (migrated from config.py) baseline internal
    2 files
    • defaults.py
    • runtime.py
  • Added src/plating/discovery/ subpackage with finder.py (121 lines) and templates.py (188 lines) instantiate internal
    2 files
    • finder.py
    • templates.py
  • Added src/plating/generation/ subpackage with adorner.py (86 lines), plater.py (111 lines), and renderer.py (58 lines) instantiate internal
    3 files
    • adorner.py
    • plater.py
    • renderer.py

Core utilities

instantiate behavioral
4 files changed
  • doc_generator.py Documentation generation orchestration (242 lines)
  • project_utils.py Project-level helpers (66 lines)
  • schema_helpers.py Schema extraction utilities (146 lines)
  • formatters.py Schema formatting utilities (221 lines)
  • Added src/plating/core/doc_generator.py (242 lines) for documentation generation orchestration instantiate internal
    1 file
    • doc_generator.py
  • Added src/plating/core/project_utils.py (66 lines) for project-level helpers instantiate internal
    1 file
    • project_utils.py
  • Added src/plating/core/schema_helpers.py (146 lines) for schema extraction utilities instantiate internal
    1 file
    • schema_helpers.py
  • Added src/plating/schema_utils/formatters.py (221 lines) for schema formatting instantiate internal
    1 file
    • formatters.py

Test provider documentation

qualify internal
4 files changed
  • env_variables.md Generated data source docs
  • file_info.md Generated data source docs
  • file_content.md Generated resource docs
  • string_manipulation.md Generated function docs
  • Generated documentation in test-provider-docs/ for all pyvider component types (data sources, resources, functions) qualify internal
    3 files
    • env_variables.md
    • file_content.md
    • string_manipulation.md

API module restoration

instantiate behavioral
1 file changed
  • api.py Re-added as slim API facade (72 lines)

Documentation regeneration script

instantiate internal
1 file changed
  • regenerate_docs.py Automated documentation regeneration (69 lines)
  • Added regenerate_docs.py (69 lines) for automated documentation regeneration instantiate internal
    1 file
    • regenerate_docs.py
← 2025-09-16 plating changelog → 2025-09-21 plating →