Doc fragments to plugins (#50172)

* promote doc_fragments into actual plugins

  change tests hardcoded path to doc fragments
  avoid sanity in fragments
  avoid improper testing of doc_fragments
  also change runner paths
 fix botmeta
 updated comment for fragments
 updated docs
This commit is contained in:
Brian Coca 2019-01-23 20:03:47 -05:00 committed by GitHub
commit 96b3ef5553
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
106 changed files with 51 additions and 31 deletions

View file

@ -0,0 +1,59 @@
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Kevin Breit (@kbreit) <kevin.breit@kevinbreit.net>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
# Standard files for documentation fragment
DOCUMENTATION = r'''
notes:
- More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs).
- Some of the options are likely only used for developers within Meraki.
options:
auth_key:
description:
- Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
type: str
host:
description:
- Hostname for Meraki dashboard.
- Only useful for internal Meraki developers.
type: str
default: 'api.meraki.com'
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
use_https:
description:
- If C(no), it will use HTTP. Otherwise it will use HTTPS.
- Only useful for internal Meraki developers.
type: bool
default: 'yes'
output_level:
description:
- Set amount of debug output during module execution
type: str
choices: [ normal, debug ]
default: normal
timeout:
description:
- Time to timeout for HTTP requests.
type: int
default: 30
validate_certs:
description:
- Whether to validate HTTP certificates.
type: bool
default: 'yes'
org_name:
description:
- Name of organization.
type: str
aliases: [ organization ]
org_id:
description:
- ID of organization.
type: str
'''