Module documentation contains broken links to other modules

[mikemorency]

Summary

Now that the collection documentation is being generated on PR/MR, we can see that certain modules are referencing other modules that dont exist.

The workflow here provides the following warnings:

/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/content_locallibrary_module.rst:697: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.content_library_item_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/content_locallibrary_module.rst:699: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.content_library_item_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/content_locallibrary_module.rst:699: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.content_library_item_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/content_subscribedlibrary_module.rst:699: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.content_library_item_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/content_subscribedlibrary_module.rst:701: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.content_library_item_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/content_subscribedlibrary_module.rst:701: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.content_library_item_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/vcenter_storage_policies_info_module.rst:125: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.vcenter_storage_policies_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/vcenter_vm_hardware_disk_module.rst:309: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.vcenter_storage_policies_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/vcenter_vm_module.rst:2148: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.vcenter_storage_policies_module'
/home/runner/work/_temp/docsbuild/head/rst/collections/vmware/vmware_rest/vcenter_vm_storage_policy_module.rst:489: WARNING: undefined label: 'ansible_collections.vmware.vmware_rest.vcenter_storage_policies_module'

These warning messages are usually treated as failures. This behavior has been disabled in the workflow for now, but it should be re-enabled

These broken links cannot be updated in the modules themselves since the modules and the docs inside the modules are autogenerated from the API spec.

Issue Type

Documentation Report

Component Name

Validate Ansible Docs workflow
content_locallibrary_module
content_subscribedlibrary_module
vcenter_storage_policies_info_module
vcenter_vm_hardware_disk_module
vcenter_vm_module
vcenter_vm_storage_policy_module

Ansible Version

No response

Collection Versions

4.0.0-dev0

Configuration

$ ansible-config dump --only-changed

OS / Environment

No response

Additional Information

Based on my initial search, heres what i think the issue is

content_library_item_module missing
it looks like we expect the module to be generated but it was not generated. In the API spec, i noticed that the object key for content_library_item_module is listed twice, once with the post method and once with the get method. I think when we generated the modules, the content builder just went with the last defined object which happens to be the GET method.

vcenter_storage_policies_module missing
we dont generate this module, and dont expect it to be generated. Maybe we should, or just remove references to it

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[mikemorency]

fixed with the latest release (4.0.0)