Dagger
Search

terraform-docs

No long description provided.

Installation

dagger install github.com/tsirysndr/daggerverse/terraform-docs@5b57e7938844ebc231a51e9022be2fab01bac7ba

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
pathStringKind -No description provided
formatStringKind -No description provided
outputStringKind -No description provided
Example
Function TerraformDocs.generate is not accessible from the terraform-docs module
func (m *myModule) example(src )   {
	return dag.
			TerraformDocs().
			Generate(src)
}
@function
def example(src: ) -> :
	return (
		dag.terraform_docs()
		.generate(src)
	)
@func()
example(src: ):  {
	return dag
		.terraformDocs()
		.generate(src)
}