Update module documentation about ref links (#76088)

* Update module documentation about ref links
pull/76168/head
Brian Scholer 3 years ago committed by GitHub
parent cc3f1d238c
commit 4abc669c24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -217,11 +217,20 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
- ref: aci_guide - ref: aci_guide
description: Detailed information on how to manage your ACI infrastructure using Ansible. description: Detailed information on how to manage your ACI infrastructure using Ansible.
# Reference by rST documentation anchor (with custom title)
- ref: The official Ansible ACI guide <aci_guide>
description: Detailed information on how to manage your ACI infrastructure using Ansible.
# Reference by Internet resource # Reference by Internet resource
- name: APIC Management Information Model reference - name: APIC Management Information Model reference
description: Complete reference of the APIC object model. description: Complete reference of the APIC object model.
link: https://developer.cisco.com/docs/apic-mim-ref/ link: https://developer.cisco.com/docs/apic-mim-ref/
* If you use ``ref:`` to link to an anchor that is not associated with a title, you must add a title to the ref for the link to work correctly.
* You can link to non-module plugins with ``ref:`` using the rST anchor, but plugin and module anchors are never associated with a title, so you must supply a title when you link to them. For example ``ref: namespace.collection.plugin_name lookup plugin <ansible_collections.namespace.collection.plugin_name_lookup>``.
:notes: :notes:
* Details of any important information that doesn't fit in one of the above sections. * Details of any important information that doesn't fit in one of the above sections.

Loading…
Cancel
Save