jedelman8/ansible-webdocs

Auto generate markdown docs for documented Ansible modules

ansible-webdocs's Issues

Problems with later releases of Ansible

There seems to have be some issues with this module using later releases of Ansible. I'm able to create documentation using Ansible 1.8.4, but not with Ansible 1.9.1.

I'm able to create a task looking like this with Ansible 1.8.4

• name: print
  debug: msg="{{ item['module'] }}"
  with_items: modules.results

In 1.9.1 I can only do this:

• name: print
  debug: msg="{{ modules }}"

Basically the "register: modules" returns a different structure in different versions of Ansible.

I haven't done any more troubleshooting but wanted to let you know.

Project License

Hello,

What is the license of this project?
We would like to use your module and template in our project.
Currently we are using Apache 2.

Unable to generate documentation

Hi ,

I am trying to generate the markdown for a custom module that i wrote, the module follows the Ansible standards in documentation and i do not suspect anything wrong here. It is creating a markdown with empty content ( just the header and the sub-header). The module path etc is set correctly in my playbook used to generate the markdown.

I am using ansible 1.8.4

Please help

vagrant@vagrant-ubuntu-trusty-64:~/ansible-webdocs/ansible-webdocs$ ansible-playbook create-ansible-webdoc.yml -i /home/vagrant/playbooks/inventory

PLAY [create local markdown doc] **********************************************

TASK: [get docs and examples for modules] *************************************
ok: [localhost]

TASK: [build web/markdown ansible docs] ***************************************
changed: [localhost]

PLAY RECAP ********************************************************************
localhost : ok=2 changed=1 unreachable=0 failed=0

vagrant@vagrant-ubuntu-trusty-64:/ansible-webdocs/ansible-webdocs$ cd web/
vagrant@vagrant-ubuntu-trusty-64:/ansible-webdocs/ansible-webdocs/web$ vi ansiblefilesdoc.md
vagrant@vagrant-ubuntu-trusty-64:~/ansible-webdocs/ansible-webdocs/web$

Below is the markdown that got generated

Ansible module for Vistara Maintenance

Schedule a Vistara Maintenance Window

---

Requirements

• See official Ansible docs

---

Modules

---

---

Created by Jason Edelman. February 2015.