terraform-docs

This module provides a function to generate Terraform modules documentation.

Installation

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

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()
}

Generate Terraform modules documentation

File !

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@e8bed26dfefaaf4ef3d00958965575131f34c69c 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)
}