Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Generate ¶
Generate produces terraform-docs markdown table output for a module directory. It looks for .terraform-docs.yml in moduleDir itself.
func GenerateWithConfig ¶
GenerateWithConfig produces terraform-docs markdown table output. moduleDir contains the .tf files to document. configDir is where to look for .terraform-docs.yml/.yaml configuration.
func InjectIntoReadme ¶
InjectIntoReadme injects terraform-docs output into a README string. If the README contains BEGIN/END markers, content between them is replaced. Otherwise the docs are appended.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.