Metadata-Version: 2.1
Name: cloudformation-docs
Version: 0.3.0
Summary: Generate docs from cloudformation templates
Home-page: https://github.com/eamonnfaherty/cloudformation-doc-generator
Author: Eamonn Faherty
Author-email: packages@designandsolve.co.uk
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: click (==7.0)
Requires-Dist: Jinja2 (>=2.10.1)
Requires-Dist: cfn-flip (==1.2.0)

# What is this?

Installing this tool will provide you with the command ```cfn-docs```.

The command ```cfn-docs``` accepts an AWS CloudFormation template and returns a description of the 
template in markdown:

```bash
cfn-docs org-bootstrap.template.yaml > org-bootstrap.template.README.md
```

In the example above we redirect the std out into a file.

## What does it read?
The tool will read the description from the template, each parameter, each resource and each output.  It will output
those descriptions in a markdown document under suitable headers.  It also lists parameters, resources and outputs 
that do not have any descriptions.

