Documentation in custom collection

Archives Ansible Project
1

Hi,

I have created a new network module collection using resource module builder which has “docs” as one of the directories, when referenced cisco ios collection, can see some network module related “.rst” files that were present in the docs directory.
Can you please guide me how to create these .rst files for the custom collections(modules in specific) ?

Hope will get an answer as soon as possible, thanks in advance.

Thanks,
Nitesh

2

Can anybody please answer my query regarding the doc section of collection in ansible NRM?

3

Hi Nitesh,

Those RST files are generated by the following tool: https://github.com/ansible-network/collection_prep.

Thanks.

4

Hi,

As I am very new to this, can you please tell me what is the exact procedure?
I have modules inside the plugin folder but the doc folder doesn’t have anything, do i need to keep the modules Documentation itself in yaml format inside the doc folder or do I need to run this collection prep on the collection directory itself?

Thanks,
Nitesh

5

Hello Nitesh,

Please go through the Doc Generator section in the README of the collection_prep tool. It has been explained there.

Thanks.

6

Thank you for your response