Skip to main content

Generate docs from cloudformation templates

Project description

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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudformation-docs-0.3.2.tar.gz (2.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page