Generating Ansible modules extras documentation

Archives Ansible Developer
1

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

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

2

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

3

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

4

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
5

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