Dagger
Search

terraform-docs

No long description provided.

Installation

dagger install github.com/tsirysndr/daggerverse/terraform-docs@0281c77a20e614d15efe9a45fe8f60a42827a645

Entrypoint

Return Type
TerraformDocs
Example
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
NameTypeDefault ValueDescription
srcDirectory !-No description provided
pathString -No description provided
formatString -No description provided
outputString -No description provided
Example
dagger -m github.com/tsirysndr/daggerverse/terraform-docs@0281c77a20e614d15efe9a45fe8f60a42827a645 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)
}