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

Backport #52368 into 2018.3 #53456

Closed
wants to merge 48 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
ec7fa89
initial tests for module documentation
mchugh19 Mar 30, 2019
4ac53f0
add aix_shadow
mchugh19 Mar 30, 2019
bfbe3b8
add aptly doc
mchugh19 Mar 30, 2019
d91ce5a
add boto3_sns docs
mchugh19 Mar 30, 2019
0e335ea
add boto_s3 docs
mchugh19 Mar 30, 2019
92cc811
add needed modules for doc test
mchugh19 Mar 30, 2019
bec8d11
remove docs not in 2018.3
Ch3LL Jun 11, 2019
113c60a
add state documention tests and missing docs
mchugh19 Mar 31, 2019
29cfaea
remove state docs not in 2018.3
Ch3LL Jun 11, 2019
2922e42
update formatting
mchugh19 Mar 31, 2019
d965c5d
Update salt.modules.aptly.rst
mchugh19 Mar 31, 2019
0fd398c
Update salt.modules.boto_s3.rst
mchugh19 Mar 31, 2019
2c62c07
Update salt.modules.cryptdev.rst
mchugh19 Mar 31, 2019
3741da4
Update salt.modules.esxcluster.rst
mchugh19 Mar 31, 2019
a78ba6c
Update salt.modules.esxdatacenter.rst
mchugh19 Mar 31, 2019
977f13c
Update salt.modules.esxvm.rst
mchugh19 Mar 31, 2019
256be5c
Update salt.modules.highstate_doc.rst
mchugh19 Mar 31, 2019
43cc43d
Update salt.modules.nexus.rst
mchugh19 Mar 31, 2019
4b77398
Update salt.modules.vcenter.rst
mchugh19 Mar 31, 2019
5b6981f
Update salt.modules.win_auditpol.rst
mchugh19 Mar 31, 2019
a8df0dd
Update salt.modules.win_wusa.rst
mchugh19 Mar 31, 2019
bf47566
Update salt.states.boto3_sns.rst
mchugh19 Mar 31, 2019
607b0c6
document cloud modules
mchugh19 Mar 31, 2019
aaee0b1
remove beacon docs not in 2018.3
Ch3LL Jun 11, 2019
829cb67
add engines
mchugh19 Mar 31, 2019
12271f8
remove engine docs not in 2018.3
Ch3LL Jun 11, 2019
a700bef
support grains
mchugh19 Mar 31, 2019
99fa2c1
remove grain docs not in 2018.3
Ch3LL Jun 11, 2019
2c217fb
support output
mchugh19 Mar 31, 2019
d059f4e
remove output docs not in 2018.3
Ch3LL Jun 11, 2019
b55cbf8
support pillars
mchugh19 Mar 31, 2019
fff3a29
remove pillar docs not in 2018.3
Ch3LL Jun 11, 2019
9088078
support proxy
mchugh19 Mar 31, 2019
4d25897
remove proxy docs not in 2018.3
Ch3LL Jun 11, 2019
ca6d5d9
support renderers
mchugh19 Mar 31, 2019
13221ff
remove renderer docs not in 2018.3
Ch3LL Jun 11, 2019
dd9f951
support retuners
mchugh19 Mar 31, 2019
74f09f2
remove returner docs not in 2018.3
Ch3LL Jun 11, 2019
282b859
add runners
mchugh19 Mar 31, 2019
67ed291
support tops and wheel docs
mchugh19 Mar 31, 2019
05374f8
fix title
mchugh19 Mar 31, 2019
bae4ee4
get execution module documentation compiling... pshew!
mchugh19 Mar 31, 2019
efc184c
docs building up to states
mchugh19 Apr 2, 2019
c22c36d
fix state docs
mchugh19 Apr 2, 2019
d610eec
update indexes for a clean build
mchugh19 Apr 3, 2019
cbdd812
doc fixes
mchugh19 Apr 3, 2019
f6e203c
clean build?
mchugh19 Apr 4, 2019
6870724
remove modules not in 2018.3
Ch3LL Jun 11, 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
1 change: 1 addition & 0 deletions doc/ref/beacons/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ beacon modules
:template: autosummary.rst.tmpl

adb
aix_account
avahi_announce
bonjour_announce
btmp
Expand Down
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:
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:
8 changes: 8 additions & 0 deletions doc/ref/grains/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,20 @@ grains modules
disks
esxi
extra
fibre_channel
fx2
iscsi
junos
marathon
mdadm
mdata
metadata
minion_process
napalm
nxos
opts
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.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.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:
17 changes: 17 additions & 0 deletions doc/ref/modules/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ execution modules

acme
aix_group
aix_shadow
aliases
alternatives
ansiblegate
Expand All @@ -31,6 +32,7 @@ execution modules
apf
apkpkg
aptpkg
aptly
archive
artifactory
at
Expand All @@ -44,6 +46,7 @@ execution modules
bluez_bluetooth
boto3_elasticache
boto3_route53
boto3_sns
boto_apigateway
boto_asg
boto_cfn
Expand All @@ -67,6 +70,7 @@ execution modules
boto_lambda
boto_rds
boto_route53
boto_s3
boto_s3_bucket
boto_secgroup
boto_sns
Expand All @@ -86,6 +90,7 @@ execution modules
chef
chocolatey
chronos
cimc
cisconso
cloud
cmdmod
Expand All @@ -96,6 +101,7 @@ execution modules
cp
cpan
cron
cryptdev
csf
cyg
daemontools
Expand Down Expand Up @@ -128,7 +134,10 @@ execution modules
elasticsearch
environ
eselect
esxcluster
esxdatacenter
esxi
esxvm
etcd_mod
ethtool
event
Expand All @@ -142,6 +151,7 @@ execution modules
freebsdpkg
freebsdports
freebsdservice
gcp_addon
gem
genesis
gentoo_service
Expand All @@ -150,6 +160,7 @@ execution modules
github
glance
glanceng
glassfish
glusterfs
gnomedesktop
gpg
Expand All @@ -164,6 +175,7 @@ execution modules
heat
hg
hipchat
highstate_doc
hosts
http
ifttt
Expand Down Expand Up @@ -286,6 +298,7 @@ execution modules
network
neutron
neutronng
nexus
nfs3
nftables
nginx
Expand Down Expand Up @@ -447,11 +460,13 @@ execution modules
vault
vbox_guest
vboxmanage
vcenter
victorops
virt
virtualenv_mod
vsphere
webutil
win_auditpol
win_autoruns
win_certutil
win_dacl
Expand Down Expand Up @@ -486,6 +501,8 @@ execution modules
win_update
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.aptly.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
salt.modules.aptly module
=========================

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

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

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

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

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

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

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

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

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

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

.. automodule:: salt.modules.nexus
:members:
:undoc-members:
1 change: 1 addition & 0 deletions doc/ref/modules/all/salt.modules.shadow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ modules:
====================================== ========================================
Execution Module Used for
====================================== ========================================
:py:mod:`~salt.modules.aix_shadow` AIX
:py:mod:`~salt.modules.shadow` Linux
:py:mod:`~salt.modules.bsd_shadow` FreeBSD, OpenBSD, NetBSD
:py:mod:`~salt.modules.solaris_shadow` Solaris-based OSes
Expand Down
6 changes: 6 additions & 0 deletions doc/ref/modules/all/salt.modules.vcenter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
salt.modules.vcenter module
===========================

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

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

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

.. automodule:: salt.modules.wordpress
:members:
:undoc-members:
3 changes: 3 additions & 0 deletions doc/ref/pillar/all/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ pillar modules
django_orm
ec2_pillar
etcd_pillar
extra_minion_data_in_pillar
file_tree
foreman
git_pillar
Expand All @@ -33,6 +34,7 @@ pillar modules
makostack
mongo
mysql
nacl
neutron
nodegroups
pepa
Expand All @@ -41,6 +43,7 @@ pillar modules
puppet
reclass_adapter
redismod
rethinkdb_pillar
s3
saltclass
sql_base
Expand Down
Loading