# TFNFR2 - Module Documentation Generation

Module Specification for the Azure Verified Modules (AVM) program

ID: TFNFR2 - Category: Documentation - Module Documentation Generation Terraform modules documentation MUST be automatically generated via Terraform Docs.
A file called .terraform-docs.yml MUST be present in the root of the module and have the following content:
--- ### To generate the output file to partially incorporate in the README.md, ### Execute this command in the Terraform module's code folder: # terraform-docs -c .terraform-docs.yml . formatter: "markdown document" # this is required version: "0.16.0" header-from: "_header.md" footer-from: "_footer.md" recursive: enabled: false path: modules sections: hide: [] show: [] content: |- {{ .Header }} <!-- markdownlint-disable MD033 --> {{ .Requirements }} {{ .Providers }} {{ .Resources }} <!-- markdownlint-disable MD013 --> {{ .Inputs }} {{ .Outputs }} {{ .Modules }} {{ .Footer }} output: file: README.md mode: replace template: |- <!-- BEGIN_TF_DOCS --> {{ .Content }} <!-- END_TF_DOCS --> output-values: enabled: false from: "" sort: enabled: true by: required settings: anchor: true color: true default: true description: false escape: true hide-empty: false html: true indent: 2 lockfile: true read-comments: true required: true sensitive: true type: true 

---
Source: https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/content/specs-defs/includes/terraform/shared/non-functional/TFNFR2.md
Last Modified: 0001-01-01