tfdoc
This project aims at generating Terraform module documentation.
Usage
tfdoc will parse all the files within a module's directory and generate a README.tf accordingly:
# Title: The name of the module
# Top comment prefixed by "Title: " and the following lines
# will be at the top of the Markdown file
variable "environment" {
description = "Variable descriptions will be parsed"
}
# tfdoc keeps comments right on top of resource, variable
# and output blocks. All variables and outputs are kept.
# Only resources with comments on top are.
resource "aws_instance" "this" {
# stuff
}
resource "aws_instance" "no_comment_here" {
# stuff
}
##
## tfdoc discards other "orphaned" comments
##
# We can have both comments on top
output "name" {
description = "and within outputs and variables"
}
# Data blocks are ignored
data "aws_ami" "node" {}
# The name of the module
## Resources
## Inputs
## Outputs
Original idea by https://github.com/jyrivallan