Skip to content

Commit

Permalink
combined tf docs with gomarkdoc in Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
incentrotolgaakyazi committed Sep 6, 2022
1 parent a320c5f commit 98623b3
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ build:
go build ./...

generate:
gomarkdoc -u -o README.md ./commercelayer/
gomarkdoc -u -o README.md ./commercelayer/ && cd examples/full && terraform-docs .
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,45 @@ func stringRef(val interface{}) *string


Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)

<!-- BEGIN_TF_DOCS -->
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_commercelayer"></a> [commercelayer](#requirement\_commercelayer) | >= 0.0.1 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_commercelayer"></a> [commercelayer](#provider\_commercelayer) | >= 0.0.1 |

## Modules

No modules.

## Resources

| Name | Type |
|------|------|
| [commercelayer_address.example-address](https://registry.terraform.io/providers/incentro-dc/commercelayer/latest/docs/resources/address) | resource |
| [commercelayer_address.incentro-address2](https://registry.terraform.io/providers/incentro-dc/commercelayer/latest/docs/resources/address) | resource |
| [commercelayer_address.incentro-address3](https://registry.terraform.io/providers/incentro-dc/commercelayer/latest/docs/resources/address) | resource |
| [commercelayer_address.incentro_address](https://registry.terraform.io/providers/incentro-dc/commercelayer/latest/docs/resources/address) | resource |
| [commercelayer_customer_group.incentro_customer_group](https://registry.terraform.io/providers/incentro-dc/commercelayer/latest/docs/resources/customer_group) | resource |
| [commercelayer_price_list.incentro_price_list](https://registry.terraform.io/providers/incentro-dc/commercelayer/latest/docs/resources/price_list) | resource |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_api_endpoint"></a> [api\_endpoint](#input\_api\_endpoint) | n/a | `string` | n/a | yes |
| <a name="input_auth_endpoint"></a> [auth\_endpoint](#input\_auth\_endpoint) | n/a | `string` | n/a | yes |
| <a name="input_client_id"></a> [client\_id](#input\_client\_id) | n/a | `string` | n/a | yes |
| <a name="input_client_secret"></a> [client\_secret](#input\_client\_secret) | n/a | `string` | n/a | yes |

## Outputs

No outputs.
<!-- END_TF_DOCS -->
11 changes: 8 additions & 3 deletions examples/full/.terraform-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
formatter: "markdown table"
formatter: "markdown" # this is required

version: ""

Expand All @@ -13,21 +13,26 @@ sections:
hide: []
show: []

hide-all: false # deprecated in v0.13.0, removed in v0.15.0
show-all: true # deprecated in v0.13.0, removed in v0.15.0

content: ""

output:
file: "../../README.md"
mode: replace
mode: inject
template: |-
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
output-values:
enabled: false
from: ""

sort:
enabled: true
by: required
by: name

settings:
anchor: true
Expand Down

0 comments on commit 98623b3

Please sign in to comment.