tools

Documentation

Index

• Constants
• Variables
• func GenerateDocs(out string, src string) error
• func TFAddDescToResource(resource_name string, resource_desc string) error
• type GenContext

Constants

const (
	// TF DOCS FOLDER
	TFDOCS_FOLDER    = "./docs"
	TFDOCS_RESOURCES = "/resources"
	BEGIN_GEN_DOC    = "<!-- schema generated by tfplugindocs -->"
)

Variables

var IGNORE_PROPS = [...]string{"element_id"}

Functions

func GenerateDocs

func GenerateDocs(out string, src string) error

Generates documentation markdonw files in the destination path

func TFAddDescToResource

func TFAddDescToResource(resource_name string, resource_desc string) error

Types

type GenContext

type GenContext struct {
	// contains filtered or unexported fields
}

var CTX GenContext