Merge pull request #55914 from mchugh19/doctest_master

Port #52368 doc requirement tests to master
This commit is contained in:
Daniel Wozniak 2020-04-14 10:18:39 -07:00 committed by GitHub
commit fed72cbadc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
133 changed files with 1327 additions and 257 deletions

View file

@ -11,16 +11,18 @@ beacon modules
:template: autosummary.rst.tmpl
adb
aix_account
avahi_announce
bonjour_announce
btmp
cert_info
diskusage
glxinfo
haproxy
inotify
journald
load
log
log_beacon
memusage
napalm_beacon
network_info
@ -32,7 +34,10 @@ beacon modules
sensehat
service
sh
smartos_imgadm
smartos_vmadm
status
telegram_bot_msg
twilio_txt_msg
watchdog
wtmp

View file

@ -0,0 +1,5 @@
salt.beacons.aix_account module
===============================
.. automodule:: salt.beacons.aix_account
:members:

View file

@ -0,0 +1,6 @@
======================
salt.beacons.cert_info
======================
.. automodule:: salt.beacons.cert_info
:members:

View file

@ -0,0 +1,5 @@
salt.beacons.smartos_imgadm module
==================================
.. automodule:: salt.beacons.smartos_imgadm
:members:

View file

@ -0,0 +1,5 @@
salt.beacons.smartos_vmadm module
=================================
.. automodule:: salt.beacons.smartos_vmadm
:members:

View file

@ -0,0 +1,5 @@
salt.beacons.watchdog module
============================
.. automodule:: salt.beacons.watchdog
:members:

View file

@ -12,6 +12,7 @@ cloud modules
aliyun
azurearm
clc
cloudstack
digitalocean
dimensiondata
@ -26,6 +27,7 @@ cloud modules
oneandone
opennebula
openstack
packet
parallels
profitbricks
proxmox

View file

@ -0,0 +1,6 @@
=====================
salt.cloud.clouds.clc
=====================
.. automodule:: salt.cloud.clouds.clc
:members:

View file

@ -0,0 +1,6 @@
========================
salt.cloud.clouds.packet
========================
.. automodule:: salt.cloud.clouds.packet
:members:

View file

@ -15,11 +15,13 @@ engine modules
http_logstash
ircbot
junos_syslog
libvirt_events
logentries
logstash_engine
napalm_syslog
reactor
redis_sentinel
script
slack
sqs_events
stalekey

View file

@ -0,0 +1,6 @@
salt.engines.libvirt_events module
==================================
.. automodule:: salt.engines.libvirt_events
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.engines.script module
==========================
.. automodule:: salt.engines.script
:members:
:undoc-members:

View file

@ -16,13 +16,22 @@ grains modules
disks
esxi
extra
fibre_channel
fx2
iscsi
junos
marathon
mdadm
mdata
metadata
minion_process
napalm
nvme
nxos
opts
panos
philips_hue
rest_sample
smartos
ssh_sample
zfs

View file

@ -0,0 +1,6 @@
=========================
salt.grains.fibre_channel
=========================
.. automodule:: salt.grains.fibre_channel
:members:

View file

@ -0,0 +1,6 @@
=================
salt.grains.iscsi
=================
.. automodule:: salt.grains.iscsi
:members:

View file

@ -0,0 +1,6 @@
=================
salt.grains.mdata
=================
.. automodule:: salt.grains.mdata
:members:

View file

@ -0,0 +1,6 @@
==========================
salt.grains.minion_process
==========================
.. automodule:: salt.grains.minion_process
:members:

View file

@ -0,0 +1,6 @@
================
salt.grains.nvme
================
.. automodule:: salt.grains.nvme
:members:

View file

@ -0,0 +1,6 @@
================
salt.grains.nxos
================
.. automodule:: salt.grains.nxos
:members:

View file

@ -0,0 +1,6 @@
===================
salt.grains.smartos
===================
.. automodule:: salt.grains.smartos
:members:

View file

@ -0,0 +1,6 @@
======================
salt.grains.ssh_sample
======================
.. automodule:: salt.grains.ssh_sample
:members:

View file

@ -0,0 +1,6 @@
===============
salt.grains.zfs
===============
.. automodule:: salt.grains.zfs
:members:

View file

@ -24,6 +24,7 @@ execution modules
acme
aix_group
aix_shadow
aixpkg
aliases
alternatives
@ -32,6 +33,7 @@ execution modules
apcups
apf
apkpkg
aptly
aptpkg
archive
arista_pyeapi
@ -41,6 +43,7 @@ execution modules
augeas_cfg
aws_sqs
azurearm_compute
azurearm_dns
azurearm_network
azurearm_resource
bamboohr
@ -51,6 +54,7 @@ execution modules
boto3_elasticache
boto3_elasticsearch
boto3_route53
boto3_sns
boto_apigateway
boto_asg
boto_cfn
@ -74,10 +78,12 @@ execution modules
boto_lambda
boto_rds
boto_route53
boto_s3
boto_s3_bucket
boto_secgroup
boto_sns
boto_sqs
boto_ssm
boto_vpc
bower
bridge
@ -93,6 +99,7 @@ execution modules
chef
chocolatey
chronos
chroot
cimc
ciscoconfparse_mod
cisconso
@ -105,6 +112,7 @@ execution modules
cp
cpan
cron
cryptdev
csf
cyg
daemontools
@ -137,7 +145,10 @@ execution modules
elasticsearch
environ
eselect
esxcluster
esxdatacenter
esxi
esxvm
etcd_mod
ethtool
event
@ -151,6 +162,8 @@ execution modules
freebsdpkg
freebsdports
freebsdservice
freezer
gcp_addon
gem
genesis
gentoo_service
@ -159,6 +172,7 @@ execution modules
github
glance
glanceng
glassfish
glusterfs
gnomedesktop
google_chat
@ -173,6 +187,7 @@ execution modules
hashutil
heat
hg
highstate_doc
hosts
http
icinga2
@ -227,6 +242,8 @@ execution modules
linux_acl
linux_ip
linux_lvm
linux_service
linux_shadow
linux_sysctl
localemod
locate
@ -302,6 +319,7 @@ execution modules
network
neutron
neutronng
nexus
nfs3
nftables
nginx
@ -401,9 +419,7 @@ execution modules
sensehat
sensors
serverdensity_device
service
servicenow
shadow
slack_notify
slsutil
smartos_imgadm
@ -469,12 +485,14 @@ execution modules
vault
vbox_guest
vboxmanage
vcenter
victorops
virt
virtualenv_mod
vmctl
vsphere
webutil
win_auditpol
win_autoruns
win_certutil
win_dacl
@ -509,6 +527,7 @@ execution modules
win_wua
win_wusa
winrepo
wordpress
x509
xapi_virt
xbpspkg

View file

@ -0,0 +1,6 @@
salt.modules.aix_shadow module
==============================
.. automodule:: salt.modules.aix_shadow
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.aptly module
=========================
.. automodule:: salt.modules.aptly
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.azurearm_dns module
================================
.. automodule:: salt.modules.azurearm_dns
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.boto3_sns module
=============================
.. automodule:: salt.modules.boto3_sns
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.boto_s3 module
===========================
.. automodule:: salt.modules.boto_s3
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.boto_ssm module
============================
.. automodule:: salt.modules.boto_ssm
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.chroot module
==========================
.. automodule:: salt.modules.chroot
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.cryptdev module
============================
.. automodule:: salt.modules.cryptdev
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.esxcluster module
==============================
.. automodule:: salt.modules.esxcluster
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.esxdatacenter module
=================================
.. automodule:: salt.modules.esxdatacenter
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.esxvm module
=========================
.. automodule:: salt.modules.esxvm
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.freezer module
===========================
.. automodule:: salt.modules.freezer
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.gcp_addon module
=============================
.. automodule:: salt.modules.gcp_addon
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.glassfish module
=============================
.. automodule:: salt.modules.glassfish
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.highstate_doc module
=================================
.. automodule:: salt.modules.highstate_doc
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
==========================
salt.modules.linux_service
==========================
.. automodule:: salt.modules.linux_service
:members:

View file

@ -0,0 +1,6 @@
=========================
salt.modules.linux_shadow
=========================
.. automodule:: salt.modules.linux_shadow
:members:

View file

@ -0,0 +1,6 @@
salt.modules.nexus module
=========================
.. automodule:: salt.modules.nexus
:members:
:undoc-members:

View file

@ -39,4 +39,3 @@ Execution Module Used for
.. _Homebrew: http://brew.sh/
.. _OpenCSW: http://www.opencsw.org/

View file

@ -3,4 +3,4 @@ salt.modules.salt_version
=========================
.. automodule:: salt.modules.salt_version
:members:
:members:

View file

@ -13,7 +13,8 @@ modules:
====================================== ========================================
Execution Module Used for
====================================== ========================================
:py:mod:`~salt.modules.shadow` Linux
:py:mod:`~salt.modules.aix_shadow` AIX
:py:mod:`~salt.modules.linux_shadow` Linux
:py:mod:`~salt.modules.bsd_shadow` FreeBSD, OpenBSD, NetBSD
:py:mod:`~salt.modules.solaris_shadow` Solaris-based OSes
:py:mod:`~salt.modules.win_shadow` Windows

View file

@ -0,0 +1,6 @@
salt.modules.vcenter module
===========================
.. automodule:: salt.modules.vcenter
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.win_auditpol module
================================
.. automodule:: salt.modules.win_auditpol
:members:
:undoc-members:

View file

@ -4,3 +4,4 @@ salt.modules.win_wusa
.. automodule:: salt.modules.win_wusa
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.modules.wordpress module
=============================
.. automodule:: salt.modules.wordpress
:members:
:undoc-members:

View file

@ -4,9 +4,12 @@
netapi modules
==============
.. toctree::
:maxdepth: 2
.. currentmodule:: salt.netapi
salt.netapi.rest_cherrypy
salt.netapi.rest_tornado
salt.netapi.rest_wsgi
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
rest_cherrypy
rest_tornado
rest_wsgi

View file

@ -5,6 +5,8 @@ rest_cherrypy
.. contents::
:local:
.. automodule:: salt.netapi.rest_cherrypy
.. automodule:: salt.netapi.rest_cherrypy.app
.. automodule:: salt.netapi.rest_cherrypy.wsgi

View file

@ -2,6 +2,8 @@
rest_tornado
============
.. automodule:: salt.netapi.rest_tornado
.. automodule:: salt.netapi.rest_tornado.saltnado
.. automodule:: salt.netapi.rest_tornado.saltnado_websockets
@ -54,4 +56,4 @@ REST URI Reference
---------
.. autoclass:: WebhookSaltAPIHandler
:members: post
:members: post

View file

@ -12,6 +12,7 @@ Follow one of the below links for further information and examples
:toctree:
:template: autosummary.rst.tmpl
dson
highstate
json_out
key

View file

@ -0,0 +1,6 @@
================
salt.output.dson
================
.. automodule:: salt.output.dson
:members:

View file

@ -21,6 +21,7 @@ pillar modules
django_orm
ec2_pillar
etcd_pillar
extra_minion_data_in_pillar
file_tree
foreman
git_pillar
@ -33,6 +34,7 @@ pillar modules
makostack
mongo
mysql
nacl
netbox
neutron
nodegroups
@ -42,6 +44,7 @@ pillar modules
puppet
reclass_adapter
redismod
rethinkdb_pillar
s3
saltclass
sql_base

View file

@ -0,0 +1,6 @@
=======================================
salt.pillar.extra_minion_data_in_pillar
=======================================
.. automodule:: salt.pillar.extra_minion_data_in_pillar
:members:

View file

@ -0,0 +1,6 @@
================
salt.pillar.nacl
================
.. automodule:: salt.pillar.nacl
:members:

View file

@ -0,0 +1,6 @@
============================
salt.pillar.rethinkdb_pillar
============================
.. automodule:: salt.pillar.rethinkdb_pillar
:members:

View file

@ -14,8 +14,12 @@ proxy modules
chronos
cimc
cisconso
docker
dummy
esxcluster
esxdatacenter
esxi
esxvm
fx2
junos
marathon
@ -27,3 +31,4 @@ proxy modules
philips_hue
rest_sample
ssh_sample
vcenter

View file

@ -0,0 +1,6 @@
salt.proxy.docker module
========================
.. automodule:: salt.proxy.docker
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.proxy.esxcluster module
============================
.. automodule:: salt.proxy.esxcluster
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.proxy.esxdatacenter module
===============================
.. automodule:: salt.proxy.esxdatacenter
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.proxy.esxvm module
=======================
.. automodule:: salt.proxy.esxvm
:members:
:undoc-members:

View file

@ -0,0 +1,6 @@
salt.proxy.vcenter module
=========================
.. automodule:: salt.proxy.vcenter
:members:
:undoc-members:

View file

@ -10,6 +10,7 @@ renderer modules
:toctree:
:template: autosummary.rst.tmpl
aws_kms
cheetah
dson
genshi
@ -20,6 +21,7 @@ renderer modules
json5
mako
msgpack
nacl
pass
py
pydsl

View file

@ -0,0 +1,6 @@
======================
salt.renderers.aws_kms
======================
.. automodule:: salt.renderers.aws_kms
:members:

View file

@ -0,0 +1,6 @@
===================
salt.renderers.nacl
===================
.. automodule:: salt.renderers.nacl
:members:

View file

@ -40,6 +40,7 @@ returner modules
redis_return
sentry_return
slack_returner
slack_webhook_return
sms_return
smtp_return
splunk

View file

@ -0,0 +1,6 @@
===================================
salt.returners.slack_webhook_return
===================================
.. automodule:: salt.returners.slack_webhook_return
:members:

View file

@ -15,6 +15,7 @@ runner modules
bgp
cache
cloud
config
ddns
digicertapi
doc

View file

@ -0,0 +1,6 @@
===================
salt.runners.config
===================
.. automodule:: salt.runners.config
:members:

View file

@ -25,6 +25,7 @@ state modules
augeas
aws_sqs
azurearm_compute
azurearm_dns
azurearm_network
azurearm_resource
beacon
@ -33,6 +34,7 @@ state modules
boto3_elasticache
boto3_elasticsearch
boto3_route53
boto3_sns
boto_apigateway
boto_asg
boto_cfn
@ -57,6 +59,7 @@ state modules
boto_lc
boto_rds
boto_route53
boto_s3
boto_s3_bucket
boto_secgroup
boto_sns
@ -74,6 +77,7 @@ state modules
cmd
composer
cron
cryptdev
csf
cyg
ddns
@ -85,12 +89,16 @@ state modules
docker_network
docker_volume
drac
dvs
elasticsearch
elasticsearch_index
elasticsearch_index_template
environ
eselect
esxcluster
esxdatacenter
esxi
esxvm
etcd_mod
ethtool
event
@ -102,6 +110,7 @@ state modules
github
glance
glance_image
glassfish
glusterfs
gnomedesktop
gpg
@ -116,6 +125,7 @@ state modules
group
heat
hg
highstate_doc
host
http
icinga2
@ -167,6 +177,10 @@ state modules
lvs_server
lvs_service
lxc
lxd
lxd_container
lxd_image
lxd_profile
mac_assistive
mac_keychain
mac_xattr
@ -183,6 +197,10 @@ state modules
mongodb_user
monit
mount
mssql_database
mssql_login
mssql_role
mssql_user
msteams
mysql_database
mysql_grants
@ -199,6 +217,7 @@ state modules
neutron_secgroup
neutron_secgroup_rule
neutron_subnet
nexus
nfs_export
nftables
npm
@ -214,6 +233,7 @@ state modules
pagerduty_service
pagerduty_user
panos
pbm
pcs
pdbedit
pecl
@ -316,6 +336,7 @@ state modules
win_wua
win_wusa
winrepo
wordpress
x509
xml
xmpp
@ -326,6 +347,7 @@ state modules
zabbix_template
zabbix_user
zabbix_usergroup
zabbix_usermacro
zabbix_valuemap
zcbuildout
zenoss

View file

@ -0,0 +1,5 @@
salt.states.azurearm_dns module
===============================
.. automodule:: salt.states.azurearm_dns
:members:

View file

@ -0,0 +1,5 @@
salt.states.boto3_sns module
============================
.. automodule:: salt.states.boto3_sns
:members:

View file

@ -0,0 +1,5 @@
salt.states.boto_s3 module
==========================
.. automodule:: salt.states.boto_s3
:members:

View file

@ -0,0 +1,5 @@
salt.states.cryptdev module
===========================
.. automodule:: salt.states.cryptdev
:members:

View file

@ -0,0 +1,5 @@
salt.states.dvs module
======================
.. automodule:: salt.states.dvs
:members:

View file

@ -0,0 +1,5 @@
salt.states.esxcluster module
=============================
.. automodule:: salt.states.esxcluster
:members:

View file

@ -0,0 +1,5 @@
salt.states.esxdatacenter module
================================
.. automodule:: salt.states.esxdatacenter
:members:

View file

@ -0,0 +1,5 @@
salt.states.esxvm module
========================
.. automodule:: salt.states.esxvm
:members:

View file

@ -0,0 +1,5 @@
salt.states.glassfish module
============================
.. automodule:: salt.states.glassfish
:members:

View file

@ -0,0 +1,5 @@
salt.states.highstate_doc module
================================
.. automodule:: salt.states.highstate_doc
:members:

View file

@ -0,0 +1,5 @@
salt.states.lxd module
======================
.. automodule:: salt.states.lxd
:members:

View file

@ -0,0 +1,5 @@
salt.states.lxd_container module
================================
.. automodule:: salt.states.lxd_container
:members:

View file

@ -0,0 +1,5 @@
salt.states.lxd_image module
============================
.. automodule:: salt.states.lxd_image
:members:

View file

@ -0,0 +1,5 @@
salt.states.lxd_profile module
==============================
.. automodule:: salt.states.lxd_profile
:members:

View file

@ -0,0 +1,5 @@
salt.states.mssql_database module
=================================
.. automodule:: salt.states.mssql_database
:members:

View file

@ -0,0 +1,5 @@
salt.states.mssql_login module
==============================
.. automodule:: salt.states.mssql_login
:members:

View file

@ -0,0 +1,5 @@
salt.states.mssql_role module
=============================
.. automodule:: salt.states.mssql_role
:members:

View file

@ -0,0 +1,5 @@
salt.states.mssql_user module
=============================
.. automodule:: salt.states.mssql_user
:members:

View file

@ -0,0 +1,5 @@
salt.states.nexus module
========================
.. automodule:: salt.states.nexus
:members:

View file

@ -0,0 +1,5 @@
salt.states.pbm module
======================
.. automodule:: salt.states.pbm
:members:

View file

@ -3,4 +3,4 @@ salt.states.saltutil
====================
.. automodule:: salt.states.saltutil
:members:
:members:

View file

@ -0,0 +1,5 @@
salt.states.wordpress module
============================
.. automodule:: salt.states.wordpress
:members:

View file

@ -0,0 +1,5 @@
salt.states.zabbix_usermacro module
===================================
.. automodule:: salt.states.zabbix_usermacro
:members:

View file

@ -7,6 +7,7 @@ Legacy salt-cloud Release Notes
===============================
.. versionchanged:: 2014.1.0
As of Salt's 2014.1.0 release salt-cloud is part of mainline
Salt. Future salt-cloud release notes will be included in Salt's regular
release notes.

View file

@ -139,7 +139,7 @@ Fork a Repo Guide_>`_ and is well worth reading.
GOOD
.. code-block::
.. code-block:: none
Fix broken things in file1 and file2
@ -157,7 +157,7 @@ Fork a Repo Guide_>`_ and is well worth reading.
BAD
.. code-block::
.. code-block:: none
Fixes broken things

View file

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""
CenturyLink Cloud Module
===================
========================
.. versionadded:: Oyxgen
@ -29,9 +29,12 @@ clc-sdk can be installed via pip:
For sdk reference see: https://github.com/CenturyLinkCloud/clc-python-sdk
Flask
-------
-----
flask can be installed via pip:
.. code-block:: bash
pip install flask
Configuration

View file

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""
Packet Cloud Module Using Packet's Python API Client
===========================================
====================================================
The Packet cloud module is used to control access to the Packet VPS system.
@ -13,17 +13,18 @@ The Packet profile requires ``size``, ``image``, ``location``, ``project_id``
Optional profile parameters:
- ``storage_size`` - min value is 10, defines Gigabytes of storage that will be attached to device.
- ``storage_tier`` - storage_1 - Standard Plan, storage_2 - Performance Plan
- ``snapshot_count`` - int
- ``snapshot_frequency`` - string - possible values:
- 1min
- 15min
- 1hour
- 1day
- 1week
- 1month
- 1year
- ``storage_size`` - min value is 10, defines Gigabytes of storage that will be attached to device.
- ``storage_tier`` - storage_1 - Standard Plan, storage_2 - Performance Plan
- ``snapshot_count`` - int
- ``snapshot_frequency`` - string - possible values:
- 1min
- 15min
- 1hour
- 1day
- 1week
- 1month
- 1year
This driver requires Packet's client library: https://pypi.python.org/pypi/packet-python
@ -536,7 +537,9 @@ def list_nodes(call=None):
"""
Returns a list of devices, keeping only a brief listing.
CLI Example:
.. code-block:: bash
salt-cloud -Q
salt-cloud --query
salt-cloud -f list_nodes packet-provider

View file

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
"""
.. _`saltify-module`:
.. _saltify-module:
Saltify Module
==============

Some files were not shown because too many files have changed in this diff Show more