# Generating Ansible modules extras documentation

**URL:** <https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825>\
**Category:** Ansible Developer\
**Created:** [March 24, 2015, 3:42am UTC](https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825 "2015-03-24T03:42:46Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![Alistair\_Israel](https://avatars.discourse-cdn.com/v4/letter/a/71e660/32.png) [@Alistair\_Israel](https://forum.ansible.com/u/Alistair_Israel)\
**Post date:** [March 24, 2015, 3:42am UTC](https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825/1 "2015-03-24T03:42:46Z")

</div>

Hi, Ansible. I’ve written a couple of Ansible custom modules for managing Ceph pools and rbds here: [https://github.com/aisrael/ansible-modules-extras/tree/wip-ceph](https://github.com/aisrael/ansible-modules-extras/tree/wip-ceph)

It’s still a work in progress: I’ll be adding a couple of more features and might rearrange the module names & functions as I go along.

Meanwhile, I’d like to see if I’m writing the module documentation correctly. Can anyone point me out to a quick “how to” in generating the Ansible documentation using Sphinx?

Thanks,  
Alistair

---

<div class="post-metadata">

**Author:** ![Alistair\_Israel](https://avatars.discourse-cdn.com/v4/letter/a/71e660/32.png) [@Alistair\_Israel](https://forum.ansible.com/u/Alistair_Israel)\
**Post date:** [March 24, 2015, 3:47am UTC](https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825/2 "2015-03-24T03:47:59Z")

</div>

Sorry, should’ve added:

When I run “make viewdocs” from the docsite directory, I get the Ansible documentation but without the modules index, and, specifically, without the ansible-modules-extras documentation.

TIA!  
Alistair

---

<div class="post-metadata">

**Author:** ![Brian\_Coca](https://avatars.discourse-cdn.com/v4/letter/b/6de8d8/32.png) [@Brian\_Coca](https://forum.ansible.com/u/Brian_Coca)\
**Post date:** [March 24, 2015, 4:23am UTC](https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825/3 "2015-03-24T04:23:22Z")

</div>

make webdocs, should create it including modules. Also you can use  
ansible-doc as a quick format validator.

---

<div class="post-metadata">

**Author:** ![Alistair\_Israel](https://avatars.discourse-cdn.com/v4/letter/a/71e660/32.png) [@Alistair\_Israel](https://forum.ansible.com/u/Alistair_Israel)\
**Post date:** [April 6, 2015, 11:02am UTC](https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825/4 "2015-04-06T11:02:26Z")

</div>

Thank you, Brian.

I finally got it to generate them by changing just symlinking lib/ansible/modules/extras to my local ansible-modules-extras working copy, then executing “make webdocs”.

- alistair

---

<div class="post-metadata">

**Author:** ![Alistair\_Israel](https://avatars.discourse-cdn.com/v4/letter/a/71e660/32.png) [@Alistair\_Israel](https://forum.ansible.com/u/Alistair_Israel)\
**Post date:** [April 6, 2015, 11:03am UTC](https://forum.ansible.com/t/generating-ansible-modules-extras-documentation/17825/5 "2015-04-06T11:03:43Z")

</div>

Thank you, Brian.

I finally got it to generate them by changing just symlinking lib/ansible/modules/extras to my local ansible-modules-extras working copy, then executing “make webdocs”.

- alistair