Groups
Groups
Sign in
Groups
Groups
sphinx-users
Conversations
About
Send feedback
Help
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 PM
3/15/22
Reply to author
Sign in to reply to author
Forward
Sign in to forward
Delete
You do not have permission to delete messages in this group
Copy link
Report message
Show original message
Either email addresses are anonymous for this group or you need the view member email addresses permission to view the original message
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