# Need help regarding Ansible Role/Playbooks documentation

**URL:** <https://forum.ansible.com/t/need-help-regarding-ansible-role-playbooks-documentation/32678>\
**Category:** Ansible Project\
**Created:** [April 14, 2020, 1:45pm UTC](https://forum.ansible.com/t/need-help-regarding-ansible-role-playbooks-documentation/32678 "2020-04-14T13:45:52Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![Rahul\_Kumar1](https://avatars.discourse-cdn.com/v4/letter/r/da6949/32.png) [@Rahul\_Kumar1](https://forum.ansible.com/u/Rahul_Kumar1)\
**Post date:** [April 14, 2020, 1:45pm UTC](https://forum.ansible.com/t/need-help-regarding-ansible-role-playbooks-documentation/32678/1 "2020-04-14T13:45:52Z")

</div>

Hi Ansible Gurus,

I have many Ansible Roles and I want to document each and every variable of role with defaults values and their description and where they make sense?

Is there any better way of Documenting Ansible variables because in case roles have many variables it becomes very difficult for some one to document them manually in doc or pdf !

Regards  
Rahul

---

<div class="post-metadata">

**Author:** ![Andrew\_Latham](https://avatars.discourse-cdn.com/v4/letter/a/ed8c4c/32.png) [@Andrew\_Latham](https://forum.ansible.com/u/Andrew_Latham)\
**Post date:** [April 15, 2020, 12:13pm UTC](https://forum.ansible.com/t/need-help-regarding-ansible-role-playbooks-documentation/32678/2 "2020-04-15T12:13:38Z")

</div>

It is just YAML you can do something like [https://pypi.org/project/sphinxcontrib-yaml/](https://pypi.org/project/sphinxcontrib-yaml/) and I am sure there are parsing rules that could address variables.