jtaylor100 / cfn-doc

Generate markdown documentation for CloudFormation templates

AWS CloudFormation Documenter (cfn-doc)

Generate markdown documentation for CloudFormation templates

Usage

python -m cfn_doc /path/to/template.yaml

A template-doc.md file is generated at /path/to/template-doc.md.

Run tests

In the repository directory, create and use a virtual environment:

python -m venv env
source env/bin/activate

Install dependencies:

pip install -r requirements.txt

Execute the test runner:

python -m unittest