readme-md-generator VS terraform-docs

Terraform-docs: This tool generates documentation for your Terraform modules in various formats, such as Markdown, HTML, and JSON. Terraform-docs parses your Terraform code and extracts documentation from comments, variable and output descriptions, and input/output examples. The tool then generates a table of contents with links to the relevant documentation for each module, which makes it easy to understand the purpose and usage of each module.

Terraform docs

I have been using https://terraform-docs.io to generate documentation of my terraform modules. However creating nested objects with optionals makes the documentation rather ugly and hard to read. See gh issue which also describes this type of issue: https://github.com/terraform-docs/terraform-docs/issues/656

I am looking for a way to automate doc creation and updates for ansible roles. I recently discovered terraform-docs and I am curious if there is something similar for ansible.

terraform-docs: https://github.com/terraform-docs/terraform-docs

Do you have other Terraform-related open-source tools that you recommend? Please go ahead and add in the comments!

Documentation:terraform-docs: https://github.com/terraform-docs/terraform-docs

terraform-docs

This was a decent read. I definitely found myself agreeing with many of the points here. I do prefer terragrunt over the use of tfvar files though and I didn't see terraform-docs mentioned which is an excellent tool for building standardized module documentation

Today we are going to look at a cool tool that can be used to "automagically" generate your Terraform module documentation called terraform-docs.

I'm wondering how you will add support for documentation? we currently have HEADER.md which is merged with the auto generated docs from https://github.com/terraform-docs/terraform-docs - and pushed to gh-pages