Skip to main content

Tool to document CloudFormation templates in Markdown.

Project description

# cloudformation-autodoc
[![Circle CI](https://circleci.com/gh/Linuturk/cloudformation-autodoc.svg?style=svg)](https://circleci.com/gh/Linuturk/cloudformation-autodoc)

## Install

`pip install cfautodoc`

## Usage

```
usage: cfautodoc [-h] [--output OUTPUT] [--timestamp TIMESTAMP]
[--insert INSERT]
template

Document CloudFormation templates in Markdown.

positional arguments:
template the JSON template to document

optional arguments:
-h, --help show this help message and exit
--output OUTPUT Output the Markdown
--timestamp TIMESTAMP
Add a timestamp to the end of the output.
--insert INSERT Block of Markdown to insert into the output.
```

## Ansible Module

To install place `ansible/library/cloudformation_autodoc.py` in the [library path](http://docs.ansible.com/ansible/intro_configuration.html#library) for Ansible.

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

cfautodoc-0.1.tar.gz (2.5 kB view hashes)

Uploaded Source

Built Distributions

cfautodoc-0.1-py2.7.egg (4.5 kB view hashes)

Uploaded Source

cfautodoc-0.1-py2-none-any.whl (4.4 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page