Merge pull request saltstack#52368 from mchugh19/doc_tests

Unit test to require execution module documentation
mchugh19 · Jan 19, 2020 · d8b505e · d8b505e
1 parent 40e55b5
commit d8b505e
Show file tree

Hide file tree

Showing 146 changed files with 3,612 additions and 237 deletions.
diff --git a/doc/ref/beacons/all/index.rst b/doc/ref/beacons/all/index.rst
@@ -11,12 +11,14 @@ beacon modules
     :template: autosummary.rst.tmpl
 
     adb
+    aix_account
     avahi_announce
     bonjour_announce
     btmp
     diskusage
     glxinfo
     haproxy
+    http_status
     inotify
     journald
     load
@@ -32,7 +34,10 @@ beacon modules
     sensehat
     service
     sh
+    smartos_imgadm
+    smartos_vmadm
     status
     telegram_bot_msg
     twilio_txt_msg
+    watchdog
     wtmp
diff --git a/doc/ref/beacons/all/salt.beacons.aix_account.rst b/doc/ref/beacons/all/salt.beacons.aix_account.rst
@@ -0,0 +1,5 @@
+salt.beacons.aix_account module
+===============================
+
+.. automodule:: salt.beacons.aix_account
+    :members:
diff --git a/doc/ref/beacons/all/salt.beacons.http_status.rst b/doc/ref/beacons/all/salt.beacons.http_status.rst
@@ -0,0 +1,5 @@
+salt.beacons.http_status module
+===============================
+
+.. automodule:: salt.beacons.http_status
+    :members:
diff --git a/doc/ref/beacons/all/salt.beacons.smartos_imgadm.rst b/doc/ref/beacons/all/salt.beacons.smartos_imgadm.rst
@@ -0,0 +1,5 @@
+salt.beacons.smartos_imgadm module
+==================================
+
+.. automodule:: salt.beacons.smartos_imgadm
+    :members:
diff --git a/doc/ref/beacons/all/salt.beacons.smartos_vmadm.rst b/doc/ref/beacons/all/salt.beacons.smartos_vmadm.rst
@@ -0,0 +1,5 @@
+salt.beacons.smartos_vmadm module
+=================================
+
+.. automodule:: salt.beacons.smartos_vmadm
+    :members:
diff --git a/doc/ref/beacons/all/salt.beacons.watchdog.rst b/doc/ref/beacons/all/salt.beacons.watchdog.rst
@@ -0,0 +1,5 @@
+salt.beacons.watchdog module
+============================
+
+.. automodule:: salt.beacons.watchdog
+    :members:
diff --git a/doc/ref/clouds/all/index.rst b/doc/ref/clouds/all/index.rst
@@ -12,19 +12,22 @@ cloud modules
 
     aliyun
     azurearm
+    clc
     cloudstack
     digitalocean
     dimensiondata
     ec2
     gce
     gogrid
     joyent
+    libvirt
     linode
     lxc
     msazure
     oneandone
     opennebula
     openstack
+    packet
     parallels
     profitbricks
     proxmox

diff --git a/doc/ref/clouds/all/salt.cloud.clouds.clc.rst b/doc/ref/clouds/all/salt.cloud.clouds.clc.rst
@@ -0,0 +1,6 @@
+=====================
+salt.cloud.clouds.clc
+=====================
+
+.. automodule:: salt.cloud.clouds.clc
+    :members:
diff --git a/doc/ref/clouds/all/salt.cloud.clouds.libvirt.rst b/doc/ref/clouds/all/salt.cloud.clouds.libvirt.rst
@@ -0,0 +1,6 @@
+=========================
+salt.cloud.clouds.libvirt
+=========================
+
+.. automodule:: salt.cloud.clouds.libvirt
+    :members:
diff --git a/doc/ref/clouds/all/salt.cloud.clouds.packet.rst b/doc/ref/clouds/all/salt.cloud.clouds.packet.rst
@@ -0,0 +1,6 @@
+========================
+salt.cloud.clouds.packet
+========================
+
+.. automodule:: salt.cloud.clouds.packet
+    :members:
diff --git a/doc/ref/engines/all/index.rst b/doc/ref/engines/all/index.rst
@@ -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

diff --git a/doc/ref/engines/all/salt.engines.libvirt_events.rst b/doc/ref/engines/all/salt.engines.libvirt_events.rst
@@ -0,0 +1,6 @@
+salt.engines.libvirt_events module
+==================================
+
+.. automodule:: salt.engines.libvirt_events
+    :members:
+    :undoc-members:
diff --git a/doc/ref/engines/all/salt.engines.script.rst b/doc/ref/engines/all/salt.engines.script.rst
@@ -0,0 +1,6 @@
+salt.engines.script module
+==========================
+
+.. automodule:: salt.engines.script
+    :members:
+    :undoc-members:
diff --git a/doc/ref/grains/all/index.rst b/doc/ref/grains/all/index.rst
@@ -16,13 +16,23 @@ grains modules
     disks
     esxi
     extra
+    fibre_channel
     fx2
+    iscsi
     junos
     marathon
     mdadm
+    mdata
     metadata
+    minion_process
     napalm
+    nvme
+    nxos
+    onyx
     opts
     panos
     philips_hue
+    smartos
+    ssh_sample
     rest_sample
+    zfs
diff --git a/doc/ref/grains/all/salt.grains.fibre_channel.rst b/doc/ref/grains/all/salt.grains.fibre_channel.rst
@@ -0,0 +1,6 @@
+=========================
+salt.grains.fibre_channel
+=========================
+
+.. automodule:: salt.grains.fibre_channel
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.iscsi.rst b/doc/ref/grains/all/salt.grains.iscsi.rst
@@ -0,0 +1,6 @@
+=================
+salt.grains.iscsi
+=================
+
+.. automodule:: salt.grains.iscsi
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.mdata.rst b/doc/ref/grains/all/salt.grains.mdata.rst
@@ -0,0 +1,6 @@
+=================
+salt.grains.mdata
+=================
+
+.. automodule:: salt.grains.mdata
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.minion_process.rst b/doc/ref/grains/all/salt.grains.minion_process.rst
@@ -0,0 +1,6 @@
+==========================
+salt.grains.minion_process
+==========================
+
+.. automodule:: salt.grains.minion_process
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.nvme.rst b/doc/ref/grains/all/salt.grains.nvme.rst
@@ -0,0 +1,6 @@
+================
+salt.grains.nvme
+================
+
+.. automodule:: salt.grains.nvme
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.nxos.rst b/doc/ref/grains/all/salt.grains.nxos.rst
@@ -0,0 +1,6 @@
+================
+salt.grains.nxos
+================
+
+.. automodule:: salt.grains.nxos
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.onyx.rst b/doc/ref/grains/all/salt.grains.onyx.rst
@@ -0,0 +1,6 @@
+================
+salt.grains.onyx
+================
+
+.. automodule:: salt.grains.onyx
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.smartos.rst b/doc/ref/grains/all/salt.grains.smartos.rst
@@ -0,0 +1,6 @@
+===================
+salt.grains.smartos
+===================
+
+.. automodule:: salt.grains.smartos
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.ssh_sample.rst b/doc/ref/grains/all/salt.grains.ssh_sample.rst
@@ -0,0 +1,6 @@
+======================
+salt.grains.ssh_sample
+======================
+
+.. automodule:: salt.grains.ssh_sample
+    :members:
diff --git a/doc/ref/grains/all/salt.grains.zfs.rst b/doc/ref/grains/all/salt.grains.zfs.rst
@@ -0,0 +1,6 @@
+===============
+salt.grains.zfs
+===============
+
+.. automodule:: salt.grains.zfs
+    :members:
diff --git a/doc/ref/modules/all/index.rst b/doc/ref/modules/all/index.rst
@@ -23,6 +23,7 @@ execution modules
 
     acme
     aix_group
+    aix_shadow
     aixpkg
     aliases
     alternatives
@@ -32,6 +33,7 @@ execution modules
     apf
     apkpkg
     aptpkg
+    aptly
     archive
     arista_pyeapi
     artifactory
@@ -40,16 +42,19 @@ execution modules
     augeas_cfg
     aws_sqs
     azurearm_compute
+    azurearm_dns
     azurearm_network
     azurearm_resource
     bamboohr
+    baredoc
     bcache
     beacons
     bigip
     bluez_bluetooth
     boto3_elasticache
     boto3_elasticsearch
     boto3_route53
+    boto3_sns
     boto_apigateway
     boto_asg
     boto_cfn
@@ -73,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
@@ -92,6 +99,7 @@ execution modules
     chef
     chocolatey
     chronos
+    chroot
     cimc
     ciscoconfparse_mod
     cisconso
@@ -104,6 +112,7 @@ execution modules
     cp
     cpan
     cron
+    cryptdev
     csf
     cyg
     daemontools
@@ -136,7 +145,10 @@ execution modules
     elasticsearch
     environ
     eselect
+    esxcluster
+    esxdatacenter
     esxi
+    esxvm
     etcd_mod
     ethtool
     event
@@ -150,6 +162,8 @@ execution modules
     freebsdpkg
     freebsdports
     freebsdservice
+    freezer
+    gcp_addon
     gem
     genesis
     gentoo_service
@@ -158,6 +172,7 @@ execution modules
     github
     glance
     glanceng
+    glassfish
     glusterfs
     gnomedesktop
     google_chat
@@ -172,6 +187,7 @@ execution modules
     hashutil
     heat
     hg
+    highstate_doc
     hosts
     http
     ifttt
@@ -202,6 +218,7 @@ execution modules
     jenkinsmod
     jinja
     jira_mod
+    jsonnet
     junos
     k8s
     kapacitor
@@ -302,6 +319,8 @@ execution modules
     network
     neutron
     neutronng
+    nexus
+    nxos_upgrade
     nfs3
     nftables
     nginx
@@ -313,6 +332,7 @@ execution modules
     nxos
     nxos_api
     omapi
+    onyx
     openbsd_sysctl
     openbsdpkg
     openbsdrcctl_service
@@ -388,8 +408,10 @@ execution modules
     s3
     s6
     salt_proxy
+    salt_version
     saltcheck
     saltcloudmod
+    saltsupport
     saltutil
     schedule
     scp_mod
@@ -468,12 +490,14 @@ execution modules
     vault
     vbox_guest
     vboxmanage
+    vcenter
     victorops
     virt
     virtualenv_mod
     vmctl
     vsphere
     webutil
+    win_auditpol
     win_autoruns
     win_certutil
     win_dacl
@@ -508,6 +532,7 @@ execution modules
     win_useradd
     win_wua
     win_wusa
+    wordpress
     x509
     xapi_virt
     xbpspkg

diff --git a/doc/ref/modules/all/salt.modules.aix_shadow.rst b/doc/ref/modules/all/salt.modules.aix_shadow.rst
@@ -0,0 +1,6 @@
+salt.modules.aix_shadow module
+==============================
+
+.. automodule:: salt.modules.aix_shadow
+    :members:
+    :undoc-members:
diff --git a/doc/ref/modules/all/salt.modules.aptly.rst b/doc/ref/modules/all/salt.modules.aptly.rst
@@ -0,0 +1,6 @@
+salt.modules.aptly module
+=========================
+
+.. automodule:: salt.modules.aptly
+    :members:
+    :undoc-members: