A Sphinx Domain for Terraform (Hashicorp Configuration Language)

36 views
Skip to first unread message

Charles Bouchard-Légaré

unread,
Mar 15, 2022, 10:11:41 PM3/15/22
to sphinx-users
Hello Sphinx users,

I released a Sphinx domain for documenting Terraform modules.

https://cblegare.gitlab.io/sphinx-terraform/

It is hosted on Gitlab but a Github mirror is available

In it current state it
  • Extracts documentation from comments in .tf files
  • Provides links to highighted HCL code (like sphinx.ext.viewcode)
  • Supports combining RestructuredText and Markdown using MyST
  • Generates a domain index with documented Terraform resources
(Terraform and the Terraform Logo are trademarks of HashiCorp. Sphinx-Terraform is not associated with HashiCorp.)

I would really appreciate feedback!
Reply all
Reply to author
Forward
0 new messages