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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cloudformation-docs-0.3.2.tar.gz.
File metadata
- Download URL: cloudformation-docs-0.3.2.tar.gz
- Upload date:
- Size: 2.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b11a4812facd7b06131065e954ed8c1bcb90cf1132e3db000b6214549b923807 |
|
| MD5 | 32fed1346a30fc4e3f4d4ee95424009f |
|
| BLAKE2b-256 | 4cecda20e92c33fa1f6bb965b30bd83e4f8e3d4b2cc9da17c6bf21276d976499 |
File details
Details for the file cloudformation_docs-0.3.2-py3-none-any.whl.
File metadata
- Download URL: cloudformation_docs-0.3.2-py3-none-any.whl
- Upload date:
- Size: 3.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 86255e3dd4362cbcd046490f78886489bad7d2699da247f2c6a8ded88a1bcedf |
|
| MD5 | 6f66efff1fea4bc3bcf2b8b9abc03e03 |
|
| BLAKE2b-256 | ea0e9a956e41d88cb2581006c06cf4558c9a1188f8d3c2980fd69f45e3870221 |
