A Sphinx extension for documenting Terraform modules.
Sphinx-Terraform is simple to use and integrate smoothly with your Terraform codebase.
Programs must be written for people to read, and only incidentally for machines to execute.
-- SICP
Code can become reusable when it is clearly visible, searchable and referenceable. Sphinx-Terraform will help
- make reusable modules that application developers will find easier to find, understand and use, thus reducing bugs, support time and toil;
- show value to stakeholders, since Infrastructure as Code is an abstract and obscure topic for non-practitioners;
- promote knowledge and foster a community spirit around your code;
- keep track of why things work the way they do.
Sphinx-Terraform is