Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unit test to require execution module documentation #52368

Merged
merged 60 commits into from
Jun 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
9078210
initial tests for module documentation
mchugh19 Mar 30, 2019
0d480d3
add aixpkg docs
mchugh19 Mar 30, 2019
5147505
add aix_shadow
mchugh19 Mar 30, 2019
5ba8dc5
add aptly doc
mchugh19 Mar 30, 2019
4d0d993
add azurearm_dns docs
mchugh19 Mar 30, 2019
5a5b13d
add baredoc docs
mchugh19 Mar 30, 2019
1b96909
add boto3_sns docs
mchugh19 Mar 30, 2019
bc1068c
add boto_s3 docs
mchugh19 Mar 30, 2019
da69c20
add boto_ssm docs
mchugh19 Mar 30, 2019
aa3f32d
add chroot docs
mchugh19 Mar 30, 2019
d4c5e4f
add needed modules for doc test
mchugh19 Mar 30, 2019
62ccbeb
add state documention tests and missing docs
mchugh19 Mar 31, 2019
0fbd9f2
update formatting
mchugh19 Mar 31, 2019
099ea8d
Update salt.modules.aixpkg.rst
mchugh19 Mar 31, 2019
c0d2d31
Update salt.modules.aptly.rst
mchugh19 Mar 31, 2019
507f33e
Update salt.modules.azurearm_dns.rst
mchugh19 Mar 31, 2019
af79c3f
Update salt.modules.baredoc.rst
mchugh19 Mar 31, 2019
d3aeae3
Update salt.modules.boto_s3.rst
mchugh19 Mar 31, 2019
e91f320
Update salt.modules.boto_ssm.rst
mchugh19 Mar 31, 2019
e336561
Update salt.modules.chroot.rst
mchugh19 Mar 31, 2019
12a4642
Update salt.modules.cryptdev.rst
mchugh19 Mar 31, 2019
c723b23
Update salt.modules.esxcluster.rst
mchugh19 Mar 31, 2019
d37e8ec
Update salt.modules.esxdatacenter.rst
mchugh19 Mar 31, 2019
9961e7a
Update salt.modules.esxvm.rst
mchugh19 Mar 31, 2019
df78b6d
Update salt.modules.freezer.rst
mchugh19 Mar 31, 2019
7e2dd5b
Update salt.modules.highstate_doc.rst
mchugh19 Mar 31, 2019
5c62881
Update salt.modules.jsonnet.rst
mchugh19 Mar 31, 2019
769a1e7
Update salt.modules.nexus.rst
mchugh19 Mar 31, 2019
3f309ca
Update salt.modules.nxos_upgrade.rst
mchugh19 Mar 31, 2019
3e635e2
Update salt.modules.onyx.rst
mchugh19 Mar 31, 2019
05c8713
Update salt.modules.salt_version.rst
mchugh19 Mar 31, 2019
93b0aba
Update salt.modules.saltsupport.rst
mchugh19 Mar 31, 2019
f6d6f6d
Update salt.modules.vcenter.rst
mchugh19 Mar 31, 2019
a48ecdf
Update salt.modules.win_auditpol.rst
mchugh19 Mar 31, 2019
eee466c
Update salt.modules.win_wusa.rst
mchugh19 Mar 31, 2019
03e571a
Update salt.states.azurearm_dns.rst
mchugh19 Mar 31, 2019
365614d
Update salt.states.boto3_sns.rst
mchugh19 Mar 31, 2019
11378ff
document cloud modules
mchugh19 Mar 31, 2019
31aa7fe
add engines
mchugh19 Mar 31, 2019
e359b74
support grains
mchugh19 Mar 31, 2019
b3dc2d2
support output
mchugh19 Mar 31, 2019
e0e8d16
support pillars
mchugh19 Mar 31, 2019
2d3680b
support proxy
mchugh19 Mar 31, 2019
8762e12
support renderers
mchugh19 Mar 31, 2019
bd5282a
support retuners
mchugh19 Mar 31, 2019
b43889c
add runners
mchugh19 Mar 31, 2019
dbb5d03
support tops and wheel docs
mchugh19 Mar 31, 2019
e5ca943
fix title
mchugh19 Mar 31, 2019
d59589e
get execution module documentation compiling... pshew!
mchugh19 Mar 31, 2019
030a7c7
docs building up to states
mchugh19 Apr 2, 2019
c039d55
fix state docs
mchugh19 Apr 2, 2019
25bfe3b
update indexes for a clean build
mchugh19 Apr 3, 2019
9ba7032
doc fixes
mchugh19 Apr 3, 2019
07d97a5
clean build?
mchugh19 Apr 4, 2019
326f250
Merge branch 'develop' into doc_tests
mchugh19 May 15, 2019
e14b745
add win_task docs
mchugh19 May 15, 2019
3262b87
Merge branch 'develop' into doc_tests
waynew May 23, 2019
cd13e55
Merge branch 'develop' into doc_tests
Ch3LL May 31, 2019
5188831
Update baredoc.py
mchugh19 Jun 1, 2019
6189d64
Merge branch 'develop' into doc_tests
Ch3LL Jun 4, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/ref/beacons/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -32,7 +34,10 @@ beacon modules
sensehat
service
sh
smartos_imgadm
smartos_vmadm
status
telegram_bot_msg
twilio_txt_msg
watchdog
wtmp
5 changes: 5 additions & 0 deletions doc/ref/beacons/all/salt.beacons.aix_account.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
salt.beacons.aix_account module
===============================

.. automodule:: salt.beacons.aix_account
:members:
5 changes: 5 additions & 0 deletions doc/ref/beacons/all/salt.beacons.http_status.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
salt.beacons.http_status module
===============================

.. automodule:: salt.beacons.http_status
:members:
5 changes: 5 additions & 0 deletions doc/ref/beacons/all/salt.beacons.smartos_imgadm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
salt.beacons.smartos_imgadm module
==================================

.. automodule:: salt.beacons.smartos_imgadm
:members:
5 changes: 5 additions & 0 deletions doc/ref/beacons/all/salt.beacons.smartos_vmadm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
salt.beacons.smartos_vmadm module
=================================

.. automodule:: salt.beacons.smartos_vmadm
:members:
5 changes: 5 additions & 0 deletions doc/ref/beacons/all/salt.beacons.watchdog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
salt.beacons.watchdog module
============================

.. automodule:: salt.beacons.watchdog
:members:
3 changes: 3 additions & 0 deletions doc/ref/clouds/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,23 @@ cloud modules

aliyun
azurearm
clc
cloudstack
digitalocean
dimensiondata
ec2
gce
gogrid
joyent
libvirt
linode
lxc
msazure
nova
oneandone
opennebula
openstack
packet
parallels
profitbricks
proxmox
Expand Down
6 changes: 6 additions & 0 deletions doc/ref/clouds/all/salt.cloud.clouds.clc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=====================
salt.cloud.clouds.clc
=====================

.. automodule:: salt.cloud.clouds.clc
:members:
6 changes: 6 additions & 0 deletions doc/ref/clouds/all/salt.cloud.clouds.libvirt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=========================
salt.cloud.clouds.libvirt
=========================

.. automodule:: salt.cloud.clouds.libvirt
:members:
6 changes: 6 additions & 0 deletions doc/ref/clouds/all/salt.cloud.clouds.packet.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
========================
salt.cloud.clouds.packet
========================

.. automodule:: salt.cloud.clouds.packet
:members:
2 changes: 2 additions & 0 deletions doc/ref/engines/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ engine modules
http_logstash
ircbot
junos_syslog
libvirt_events
logentries
logstash_engine
napalm_syslog
reactor
redis_sentinel
script
slack
sqs_events
stalekey
Expand Down
6 changes: 6 additions & 0 deletions doc/ref/engines/all/salt.engines.libvirt_events.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
salt.engines.libvirt_events module
==================================

.. automodule:: salt.engines.libvirt_events
:members:
:undoc-members:
6 changes: 6 additions & 0 deletions doc/ref/engines/all/salt.engines.script.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
salt.engines.script module
==========================

.. automodule:: salt.engines.script
:members:
:undoc-members:
10 changes: 10 additions & 0 deletions doc/ref/grains/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,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
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.fibre_channel.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=========================
salt.grains.fibre_channel
=========================

.. automodule:: salt.grains.fibre_channel
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.iscsi.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=================
salt.grains.iscsi
=================

.. automodule:: salt.grains.iscsi
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.mdata.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=================
salt.grains.mdata
=================

.. automodule:: salt.grains.mdata
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.minion_process.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
==========================
salt.grains.minion_process
==========================

.. automodule:: salt.grains.minion_process
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.nvme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
================
salt.grains.nvme
================

.. automodule:: salt.grains.nvme
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.nxos.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
================
salt.grains.nxos
================

.. automodule:: salt.grains.nxos
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.onyx.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
================
salt.grains.onyx
================

.. automodule:: salt.grains.onyx
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.smartos.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
===================
salt.grains.smartos
===================

.. automodule:: salt.grains.smartos
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.ssh_sample.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
======================
salt.grains.ssh_sample
======================

.. automodule:: salt.grains.ssh_sample
:members:
6 changes: 6 additions & 0 deletions doc/ref/grains/all/salt.grains.zfs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
===============
salt.grains.zfs
===============

.. automodule:: salt.grains.zfs
:members:
27 changes: 27 additions & 0 deletions doc/ref/modules/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ execution modules

acme
aix_group
aix_shadow
aixpkg
aliases
alternatives
ansiblegate
Expand All @@ -31,6 +33,7 @@ execution modules
apf
apkpkg
aptpkg
aptly
archive
arista_pyeapi
artifactory
Expand All @@ -39,16 +42,19 @@ execution modules
augeas_cfg
aws_sqs
azurearm_compute
azurearm_dns
azurearm_network
azurearm_resource
bamboohr
baredoc
bcache
beacons
bigip
bluecoat_sslv
bluez_bluetooth
boto3_elasticache
boto3_route53
boto3_sns
boto_apigateway
boto_asg
boto_cfn
Expand All @@ -72,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
Expand All @@ -91,6 +99,7 @@ execution modules
chef
chocolatey
chronos
chroot
cimc
ciscoconfparse_mod
cisconso
Expand All @@ -103,6 +112,7 @@ execution modules
cp
cpan
cron
cryptdev
csf
cyg
daemontools
Expand Down Expand Up @@ -135,7 +145,10 @@ execution modules
elasticsearch
environ
eselect
esxcluster
esxdatacenter
esxi
esxvm
etcd_mod
ethtool
event
Expand All @@ -150,6 +163,8 @@ execution modules
freebsdpkg
freebsdports
freebsdservice
freezer
gcp_addon
gem
genesis
gentoo_service
Expand All @@ -158,6 +173,7 @@ execution modules
github
glance
glanceng
glassfish
glusterfs
gnomedesktop
google_chat
Expand All @@ -172,6 +188,7 @@ execution modules
hashutil
heat
hg
highstate_doc
hosts
http
ifttt
Expand Down Expand Up @@ -202,6 +219,7 @@ execution modules
jenkinsmod
jinja
jira_mod
jsonnet
junos
k8s
kapacitor
Expand Down Expand Up @@ -302,6 +320,8 @@ execution modules
network
neutron
neutronng
nexus
nxos_upgrade
nfs3
nftables
nginx
Expand All @@ -313,6 +333,7 @@ execution modules
nxos
nxos_api
omapi
onyx
openbsd_sysctl
openbsdpkg
openbsdrcctl_service
Expand Down Expand Up @@ -388,8 +409,10 @@ execution modules
s3
s6
salt_proxy
salt_version
saltcheck
saltcloudmod
saltsupport
saltutil
schedule
scp_mod
Expand Down Expand Up @@ -469,12 +492,14 @@ execution modules
vault
vbox_guest
vboxmanage
vcenter
victorops
virt
virtualenv_mod
vmctl
vsphere
webutil
win_auditpol
win_autoruns
win_certutil
win_dacl
Expand Down Expand Up @@ -508,6 +533,8 @@ execution modules
win_timezone
win_useradd
win_wua
win_wusa
wordpress
x509
xapi_virt
xbpspkg
Expand Down
6 changes: 6 additions & 0 deletions doc/ref/modules/all/salt.modules.aix_shadow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
salt.modules.aix_shadow module
==============================

.. automodule:: salt.modules.aix_shadow
:members:
:undoc-members:
6 changes: 6 additions & 0 deletions doc/ref/modules/all/salt.modules.aixpkg.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
salt.modules.aixpkg module
==========================

.. automodule:: salt.modules.aixpkg
:members:
:undoc-members:
Loading