https://github.com/grandchild/ansible-playtodoc

Some people don't want to see the light. This makes it easier to keep them quiet.
https://github.com/grandchild/ansible-playtodoc

ansible documentation markdown wiki

Last synced: 5 days ago
JSON representation

Some people don't want to see the light. This makes it easier to keep them quiet.

• Host: GitHub
• URL: https://github.com/grandchild/ansible-playtodoc
• Owner: grandchild
• License: cc0-1.0
• Created: 2017-03-07T02:34:52.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-07T18:23:36.000Z (almost 8 years ago)
• Last Synced: 2024-12-11T10:41:02.316Z (2 months ago)
• Topics: ansible, documentation, markdown, wiki
• Language: Python
• Size: 9.77 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Ansible Play➜Doc

Creates human-readable instructions from [Ansible](https://ansible.com) Playbooks.

Output formats:

* Wiki

* Markdown

### Usage

```

playtodoc [-h] [--version] [-b BASEDIR] [-f FORMAT] [-o FILENAME] [-l LIMIT] [-v] playbook.yml

Convert Ansible Playbooks to various Markup format for human consumption.

positional arguments:

  playbook.yml

optional arguments:

  -h, --help            show this help message and exit

  --version             show program's version number and exit

  -b BASEDIR, --basedir BASEDIR

                        Ansible base dir for playbooks, roles, vars, etc.

  -f FORMAT, --format FORMAT

                        Output format, can be one of 'md', 'wiki'

  -o FILENAME, --output FILENAME

                        Output filename

  -l LIMIT, --limit LIMIT

                        Template and file inline character limit. Rendered

                        templates and files longer than this will be printed

                        into separate files and linked to. Defaults to 1000.

  -v, --verbose         Be more verbose

```

### Status

alpha, very rudimentary output.

Todo:

* more modules

* proper `with_*`-support

* more output formats

Not-Todo:

* all modules

* support for weird configurations and deep magic - standard playbooks & roles only