Provide module documentation

[andy-maier]

The modules have the required constants for generating documentation, and there is a docs directory, but yet there is no documentation web site, nor a description on how to build documentation.

The docs directory has a Makefile that is a good start but what is missing is the support for extracting the docs from the modules.

[prasad-valmeti-broadcom]

Hi Andy, This is link to build the latest documentation: https://github.com/brocade/ansible/blob/master/docs/documentation.rst

We will address this issue fixing documentation in the next release. Please let us know your comments/suggestions on this. Regards, Prasad

[prasad-valmeti-broadcom]

This is just to give an update. This document link will be updated in the Readme in the next release. Will update once the release date is finalized.

[andy-maier]

A suggestion I have for automatically building the documentation is to extract the documentation as .rst files from the source modules using ansible-doc-extractor and then to build HTML documentation using sphinx-versioning.

We do that for example in the https://github.com/zhmcclient/zhmc-ansible-modules project (see the "docs" target in the Makefile there).

We then publish the built HTML documentation to Github pages, see here for how to do that: https://github.com/zhmcclient/zhmc-ansible-modules/blob/master/.github/workflows/publish.yml#L128

[prasad-valmeti-broadcom]

Hi Andy, Thanks for the suggestion, we will consider and try to integrate for our ansible documentation. Regards, Prasad