-
Notifications
You must be signed in to change notification settings - Fork 467
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #441 from lonegunmanb/enhance-document
Add multiple terraform-docs configs to generate a seperated markdown document for input variables
- Loading branch information
Showing
5 changed files
with
159 additions
and
4 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
formatter: "markdown table" # this is required | ||
|
||
sections: | ||
hide: ["inputs"] | ||
output: | ||
file: "README.md" | ||
mode: inject |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
formatter: "markdown table" # this is required | ||
|
||
sections: | ||
show: ["inputs"] | ||
output: | ||
file: "variables.md" | ||
mode: inject |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -202,6 +202,8 @@ contact [[email protected]](mailto:[email protected]) with any additio | |
|
||
## Module Spec | ||
|
||
Input variable spec are too big for the registry to render so we have a seperated document for these variables, check it out [here](./variables.md) | ||
|
||
The following sections are generated by [terraform-docs](https://github.com/terraform-docs/terraform-docs) and [markdown-table-formatter](https://github.com/nvuillam/markdown-table-formatter), please **DO NOT MODIFY THEM MANUALLY!** | ||
|
||
<!-- BEGIN_TF_DOCS --> | ||
|
Oops, something went wrong.