Generate docs from ansible argspec

Archives Ansible Project
1

Is there any way to generate a markdown documentation from ansible role argument spec?

https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#role-argument-validation

I could not find anything in ansible-doc, the format itself suggests that there is a way

Thanks a lot

2

Hi,

Is there any way to generate a markdown documentation from ansible
role argument spec?

https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#role-argument-validation

I could not find anything in ansible-doc, the format itself suggests
that there is a way

this doesn't really answer your question (as it's producing
ReStructured Text and not MarkDown), but antsibull-docs
(https://github.com/ansible-community/antsibull/) also supports roles
(with role argument specs) next to plugins and modules.

Cheers,
Felix

3

ansible-doc -t role --json <rolename> will dump the info in JSON format, you can then use that with almost any templating engine to create a markdown formatted file.