Skip to main content

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.

Metadata

Release files for cloudformation-docs 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cloudformation-docs 0.3.2
File Size Uploaded Provenance Actions
cloudformation-docs-0.3.2.tar.gz 2.5 kB Without provenance Details for cloudformation-docs-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cloudformation-docs 0.3.2
File Interpreter ABI Platform Actions
cloudformation_docs-0.3.2-py3-none-any.whl Python 3 none any Details for cloudformation_docs-0.3.2-py3-none-any.whl

Total release size: 6.1 kB

Release files / cloudformation-docs-0.3.2.tar.gz

Download URL cloudformation-docs-0.3.2.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b11a4812facd7b06131065e954ed8c1bcb90cf1132e3db000b6214549b923807
BLAKE2b-256 checksum
How to use checksums
4cecda20e92c33fa1f6bb965b30bd83e4f8e3d4b2cc9da17c6bf21276d976499
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / cloudformation_docs-0.3.2-py3-none-any.whl

Download URL cloudformation_docs-0.3.2-py3-none-any.whl
Size 3.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
86255e3dd4362cbcd046490f78886489bad7d2699da247f2c6a8ded88a1bcedf
BLAKE2b-256 checksum
How to use checksums
ea0e9a956e41d88cb2581006c06cf4558c9a1188f8d3c2980fd69f45e3870221
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for cloudformation-docs 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page