starred/ansible
1
0
Fork 0
mirror of https://github.com/ansible/ansible.git synced 2026-08-03 08:03:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update module documentation about ref links (#76088)

Browse Source 
* Update module documentation about ref links
This commit is contained in:
Brian Scholer
2021-10-27 14:23:45 -04:00
committed by GitHub
parent cc3f1d238c
commit 4abc669c24
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
+9
View File
@@ -217,11 +217,20 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
- ref: aci_guide
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
- name: APIC Management Information Model reference
description: Complete reference of the APIC object model.
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:
* Details of any important information that doesn't fit in one of the above sections.