ansible-for-nsxt icon indicating copy to clipboard operation
ansible-for-nsxt copied to clipboard

Add rendered module documentation

Open uempfel opened this issue 4 years ago • 1 comments

Hi,

so far it is only possible to view a module's documentation by either

  • looking directly at the python code, or
  • using the ansible-doc <module_name> command (given that you added the modules to your Ansible library; Some modules could not be parsed, I fixed that in https://github.com/vmware/ansible-for-nsxt/pull/272)

While that certainly works, it would be much more user-friendly to have rendered docs (like the official Ansible module-docs)

I did a small Proof-of-Concept which leverages the build mechanism from the official Ansible Repo to generate rendered HTML pages and published it to Readthedocs: https://ansible-for-nsxt-docs.readthedocs.io/

It would be great if you'd consider adding a pipeline to this repo to auto-generate the docs and publish them. If you need any more info, I'm happy to help.

uempfel avatar Jun 03 '20 13:06 uempfel

I have been trying this module out and just like you I was looking straight into the python code. I cannot understand why this is not included in a "vmware curated module".

Would you please be so kind to share how you build the docs? (I've been trying sphinx-build but did not get far)

Edit: Just saw your github page so I guess I know enough.

MalfuncEddie avatar May 08 '22 20:05 MalfuncEddie