Documentation in custom collection

[nitesh shet]

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

[nitesh shet]

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

[Nilashish Chakraborty]

Hi Nitesh,

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

Thanks.

--
You received this message because you are subscribed to the Google Groups "Ansible Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ansible-proje...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/CAPgfy9Vro1Ed8ePiKEQrrJR%3D8z1G1izXUu3g-Ok9hO59mivNtg%40mail.gmail.com.

[nitesh shet]

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

To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/CAODNBSFBhu69JAiUzWBc-OyL9L0eKnH6zGzO%3Dt5gEEtH3Qtepg%40mail.gmail.com.

[Nilashish Chakraborty]

Hello Nitesh,

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

Thanks.

To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/CAPgfy9WfzFVQE4WhpaXrLwFQ5BKT2vS4Ku5BE-3TiAcGZtVpHQ%40mail.gmail.com.

[nitesh shet]

Thank you for your response

To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/CAODNBSGCqj_%2B8QtJrMdeb1P5-sRo0ZvuFkWTZJMY7k1ti9OKXw%40mail.gmail.com.