Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rendered module documentation #273

Open
uempfel opened this issue Jun 3, 2020 · 1 comment
Open

Add rendered module documentation #273

uempfel opened this issue Jun 3, 2020 · 1 comment

Comments

@uempfel
Copy link

uempfel commented Jun 3, 2020

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 Make docs parseable via ansible-doc #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 uempfel changed the title Add rendered modules documentation Add rendered module documentation Jun 3, 2020
@MalfuncEddie
Copy link

MalfuncEddie commented May 8, 2022

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.

alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Nov 22, 2022
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Nov 22, 2022
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Nov 22, 2022
part of vmware#273

Signed-off-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Jan 28, 2023
part of vmware#273

Signed-off-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
ggverma pushed a commit that referenced this issue Feb 28, 2023
part of #273

Signed-off-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Feb 28, 2023
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Feb 28, 2023
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Feb 28, 2023
end of vmware#273

Signed-off-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Nov 10, 2023
alagoutte added a commit to alagoutte/ansible-for-nsxt that referenced this issue Nov 10, 2023
end of vmware#273

Signed-off-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants