helm-docs
No long description provided.
Installation
dagger install github.com/sagikazarmark/daggerverse/helm-docs@82024bb95d58d29665ad9ab1457f9f98a7111d10
Entrypoint
Return Type
HelmDocs
Example
func (m *myModule) example() *HelmDocs {
return dag.
HelmDocs()
}
@function
def example() -> dag.HelmDocs:
return (
dag.helm_docs()
)
@func()
example(): HelmDocs {
return dag
.helmDocs()
}
Types
HelmDocs 🔗
container() 🔗
Return Type
Container !
Example
Function HelmDocs.container is not accessible from the helm-docs module
func (m *myModule) example() {
return dag.
HelmDocs().
Container()
}
@function
def example() -> :
return (
dag.helm_docs()
.container()
)
@func()
example(): {
return dag
.helmDocs()
.container()
}
generate() 🔗
Generate markdown documentation for Helm charts from requirements and values files.
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
chart | Directory ! | - | No description provided |
templates | [ObjectKind ! ] | - | No description provided |
sortValuesOrder | StringKind | - | No description provided |
Example
Function HelmDocs.generate is not accessible from the helm-docs module
func (m *myModule) example(chart ) {
return dag.
HelmDocs().
Generate(chart)
}
@function
def example(chart: ) -> :
return (
dag.helm_docs()
.generate(chart)
)
@func()
example(chart: ): {
return dag
.helmDocs()
.generate(chart)
}