generate the settings docs (#5740)

* generate the settings docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fmt Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * Update docs/kcl/settings.md --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-03-10 18:59:10 -07:00
parent 310932dc5a
commit 546b4ea3b8
9 changed files with 812 additions and 6 deletions
--- a/rust/kcl-lib/src/settings/templates/settings.hbs
+++ b/rust/kcl-lib/src/settings/templates/settings.hbs
@ -0,0 +1,67 @@
+---
+title: "{{title}}"
+excerpt: "{{{description}}}"
+layout: manual
+---
+
+# {{title}}
+
+{{{description}}}
+
+## {{config_type}} Structure
+
+```toml
+{{{example}}}
+```
+
+## Available Settings
+
+{{#with settings.properties}}
+{{#each this}}
+### {{@key}}
+
+{{#if metadata.description}}{{metadata.description}}{{/if}}
+
+{{#with properties}}
+{{#each this}}
+#### {{@key}}
+
+{{#if description}}{{description}}{{/if}}
+
+{{#if enum}}
+**Possible values:** {{pretty_enum enum}}
+{{/if}}
+
+**Default:** {{#if default}}{{format_default default}}{{else}}None{{/if}}
+
+{{#if properties}}
+This setting has the following nested options:
+
+{{#each properties}}
+##### {{@key}}
+
+{{#if description}}{{description}}{{/if}}
+
+{{#if enum}}
+**Possible values:** {{pretty_enum enum}}
+{{/if}}
+
+**Default:** {{#if default}}{{format_default default}}{{else}}None{{/if}}
+
+{{#if properties}}
+This setting has further nested options. See the schema for full details.
+{{/if}}
+{{/each}}
+{{/if}}
+
+{{/each}}
+{{/with}}
+
+{{/each}}
+{{/with}}
+
+## Complete Example
+
+```toml
+{{{example}}}
+```