mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07:00
baf0ad2309
* 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
77 lines
2.8 KiB
Python
77 lines
2.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
|
|
# Copyright: (c) 2017, Swetha Chunduri (@schunduri)
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
# Standard files documentation fragment
|
|
DOCUMENTATION = '''
|
|
options:
|
|
host:
|
|
description:
|
|
- IP Address or hostname of APIC resolvable by Ansible control host.
|
|
required: yes
|
|
aliases: [ hostname ]
|
|
port:
|
|
description:
|
|
- Port number to be used for REST connection.
|
|
- The default value depends on parameter `use_ssl`.
|
|
username:
|
|
description:
|
|
- The username to use for authentication.
|
|
default: admin
|
|
aliases: [ user ]
|
|
password:
|
|
description:
|
|
- The password to use for authentication.
|
|
- This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead.
|
|
required: yes
|
|
private_key:
|
|
description:
|
|
- PEM formatted file that contains your private key to be used for signature-based authentication.
|
|
- The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified.
|
|
- This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored.
|
|
required: yes
|
|
aliases: [ cert_key ]
|
|
certificate_name:
|
|
description:
|
|
- The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
|
|
- It defaults to the C(private_key) basename, without extension.
|
|
aliases: [ cert_name ]
|
|
output_level:
|
|
description:
|
|
- Influence the output of this ACI module.
|
|
- C(normal) means the standard output, incl. C(current) dict
|
|
- C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
|
|
- C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information
|
|
choices: [ debug, info, normal ]
|
|
default: normal
|
|
timeout:
|
|
description:
|
|
- The socket level timeout in seconds.
|
|
type: int
|
|
default: 30
|
|
use_proxy:
|
|
description:
|
|
- If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
|
type: bool
|
|
default: 'yes'
|
|
use_ssl:
|
|
description:
|
|
- If C(no), an HTTP connection will be used instead of the default HTTPS connection.
|
|
type: bool
|
|
default: 'yes'
|
|
validate_certs:
|
|
description:
|
|
- If C(no), SSL certificates will not be validated.
|
|
- This should only set to C(no) when used on personally controlled sites using self-signed certificates.
|
|
type: bool
|
|
default: 'yes'
|
|
seealso:
|
|
- ref: aci_guide
|
|
description: Detailed information on how to manage your ACI infrastructure using Ansible.
|
|
- ref: aci_dev_guide
|
|
description: Detailed guide on how to write your own Cisco ACI modules to contribute.
|
|
'''
|