.terraform-docs.yml

# Copyright 2023 The Authors (see AUTHORS file)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This doc exists at root-level to provide an entrypoint and default
# configuration for all sub-modules. It intentionally does not inject
# anything into the root README.md

# Recursive enables recursive search in all "modules" subdirectories
recursive:
  enabled: true

sections:
  hide:
    - 'all'

output:
  file: 'README.md'
  mode: 'insert'
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->

formatter: 'markdown table'

# This is the default content for all sub-modules
# Add a separate .terraform-docs.yml file in the submodule to override
# the defaults
content: |-
  {{ .Header }}

  {{ .Inputs }}

  {{ .Outputs }}

  {{ .Requirements }}

  {{ .Providers }}

  {{ .Resources }}

  {{ .Modules }}

  {{ .Footer }}