mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 05:42:50 +00:00
Docs: Add a "seealso" section to the module docs (#45949)
* Docs: Add a separate "seealso" section to the module docs
to list related modules and/or related references. This clears up the notes
section for things that are actual notes.
So you can add a section in your module documentation and four types of
references are possible.
seealso:
# Reference by module name
- module: aci_tenant
# Reference by module name, including description
- module: aci_tenant
description: ACI module to create tenants on a Cisco ACI fabric.
# Reference by rST documentation anchor
- ref: 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/
This PR also includes:
- Implements ansible-doc support
- Implements schema support for the seealso options
- Updates to the development documentation
- Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters
- This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again).
- We fixed the possible suboption types (which was limited to 'bool' only)
* Use latest stable instead of devel docs
This commit is contained in:
committed by
Alicia Cozine
parent
6b09e99664
commit
baf0ad2309
@@ -224,7 +224,34 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
|
||||
:notes:
|
||||
|
||||
* Details of any important information that doesn't fit in one of the above sections.
|
||||
* For example, whether ``check_mode`` is or is not supported, or links to external documentation.
|
||||
* For example, whether ``check_mode`` is or is not supported.
|
||||
|
||||
:seealso:
|
||||
|
||||
* A list of references to other modules, documentation or Internet resources
|
||||
* A reference can be one of the following formats:
|
||||
|
||||
|
||||
.. code-block:: yaml+jinja
|
||||
|
||||
seealso::
|
||||
|
||||
# Reference by module name
|
||||
- module: aci_tenant
|
||||
|
||||
# Reference by module name, including description
|
||||
- module: aci_tenant
|
||||
description: ACI module to create tenants on a Cisco ACI fabric.
|
||||
|
||||
# Reference by rST documentation anchor
|
||||
- ref: 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/
|
||||
|
||||
|
||||
Linking within module documentation
|
||||
-----------------------------------
|
||||
@@ -239,7 +266,8 @@ You can link from your module documentation to other module docs, other resource
|
||||
|
||||
.. note::
|
||||
|
||||
To refer a collection of modules, use ``C(..)``, e.g. ``Refer to the C(win_*) modules.``
|
||||
- To refer a collection of modules, use ``C(..)``, e.g. ``Refer to the C(win_*) modules.``
|
||||
- Because it stands out better, using ``seealso`` is preferred for general references over the use of notes or adding links to the description.
|
||||
|
||||
Documentation fragments
|
||||
-----------------------
|
||||
@@ -248,10 +276,13 @@ If you're writing multiple related modules, they may share common documentation,
|
||||
|
||||
For example, all AWS modules should include::
|
||||
|
||||
.. code-block:: yaml+jinja
|
||||
|
||||
extends_documentation_fragment:
|
||||
- aws
|
||||
- ec2
|
||||
|
||||
|
||||
You can find more examples by searching for ``extends_documentation_fragment`` under the Ansible source tree.
|
||||
|
||||
.. _examples_block:
|
||||
|
||||
Reference in New Issue
Block a user