We have learned from the previous recipes that in the composition of a Terraform module we have input variables, as well as outputs.
As with all packages that are made available to other teams or even publicly, it is very important to document your Terraform module.
The problem with this documentation is that it is tedious to update the document with each change and therefore quickly becomes obsolete.
Among all of the tools in the Terraform toolbox, there is terraform-docs, an open source, cross-platform tool that allows the documentation of a Terraform module to be generated automatically.
We will discuss in this recipe how to automatically generate the markdown documentation of a module with terraform-docs.
Getting ready
For this recipe, we are going to generate the documentation of the module we created in the Creating a Terraform module and using it locally recipe of this chapter, which allowed us to create a web app in Azure, the sources of which are...
