terraform-docs
No long description provided.
Installation
dagger install github.com/tsirysndr/daggerverse/terraform-docs@4f4fe6967c1e389a47b7ecd01c2f01bf520386a0
Entrypoint
Return Type
TerraformDocs
Example
dagger -m github.com/tsirysndr/daggerverse/terraform-docs@4f4fe6967c1e389a47b7ecd01c2f01bf520386a0 call \
func (m *myModule) example() *TerraformDocs {
return dag.
TerraformDocs()
}
@function
def example() -> dag.TerraformDocs:
return (
dag.terraform_docs()
)
@func()
example(): TerraformDocs {
return dag
.terraformDocs()
}
Types
TerraformDocs 🔗
generate() 🔗
Generate Terraform modules documentation
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
path | String | "." | No description provided |
format | String | "md" | No description provided |
output | String | "README.md" | No description provided |
Example
dagger -m github.com/tsirysndr/daggerverse/terraform-docs@4f4fe6967c1e389a47b7ecd01c2f01bf520386a0 call \
generate --src DIR_PATH
func (m *myModule) example(src *Directory) *File {
return dag.
TerraformDocs().
Generate(src)
}
@function
def example(src: dagger.Directory) -> dagger.File:
return (
dag.terraform_docs()
.generate(src)
)
@func()
example(src: Directory): File {
return dag
.terraformDocs()
.generate(src)
}