Metadata-Version: 2.1
Name: tfdocs
Version: 0.1.2
Summary: Documentation generator for Terraform modules
Project-URL: Homepage, https://github.com/vajeen/tfdoc
Project-URL: Issues, https://github.com/vajeen/tfdoc/issues
Author-email: Vajeen Karunathilaka <vajeen@gmail.com>
License-File: LICENCE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: gitpython==3.1.30
Requires-Dist: rich==13.3.4
Description-Content-Type: text/markdown

# TF-Doc

`tfdocs` lets you generate `README.md` for Terraform modules based on `variables.tf`.
Additionally, it can sort variable definitions.

# Usage

    tfdocs [flags]

`tfdocs` will create or update README.md in the current directory. Alternatively, you can mark s section of the README.md file with below tags `tfdocs` will only replace the content between these markers.

## Example

    # My module
    This is a module to do something.

    <!-- TFDOCS START -->

    This section will be replaced by tfdocs.

    <!-- TFDOCS END -->

    # End of README


**Note**: `tfdocs` overwrite an existing README.md file. It's always good to use `--dry-run` first.
    
Flags:

        -h, --help      help for tfdocs
        

# Authors

`tfdocs is created and maintained by [vajeen].
