Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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


Release history Release notifications

Download files

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

Files for cloudformation-docs, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size cloudformation_docs-0.1.1-py3-none-any.whl (3.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size cloudformation-docs-0.1.1.tar.gz (2.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page