mirror of
https://github.com/saltstack/salt.git
synced 2025-04-16 09:40:20 +00:00
doc: remove module suffix from descriptions
Until now, the listings of all kinds of modules looked quite
inconsistent like this:
- salt.states.smtp
- salt.states.snapper module
- salt.states.solrcloud module
- salt.states.splunk
The `module` suffix is redundant anyways, so let's remove it and do some
further cleanup (adjusting overline/underline usage, underline length)
using the following bash script:
```bash
sed -i 's|\s\+module$||g' doc/ref/*/all/*.*.rst
for rst in doc/ref/*/all/*.*.rst;
do
# enforce consistent overline/underline usage, remove all overlines
if [[ $(head -n1 "${rst}") =~ ^=+$ ]];
then
sed -i -e 1d "${rst}"
fi
# adjust the length of the underline to the length of the module name
module_name=$(head -n1 "${rst}")
underline=$(for i in $(seq ${#module_name}); do echo -n "="; done)
sed -i '2s|^=\+$|'"${underline}"'|g' "${rst}"
done
```
This commit is contained in:
Elias Probst
Megan Wilhite
parent
215e4e2dfb
commit
a9fda57b73
1246 changed files with 691 additions and 1614 deletions
|
|
@ -1,4 +1,3 @@
|
|||
==============
|
||||
salt.auth.auto
|
||||
==============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
================
|
||||
salt.auth.django
|
||||
================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============
|
||||
salt.auth.file
|
||||
==============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==================
|
||||
salt.auth.keystone
|
||||
==================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============
|
||||
salt.auth.ldap
|
||||
==============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===============
|
||||
salt.auth.mysql
|
||||
===============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=============
|
||||
salt.auth.pam
|
||||
=============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=============
|
||||
salt.auth.pki
|
||||
=============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============
|
||||
salt.auth.rest
|
||||
==============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
======================
|
||||
salt.auth.sharedsecret
|
||||
======================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
================
|
||||
salt.auth.yubico
|
||||
================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.adb module
|
||||
=======================
|
||||
salt.beacons.adb
|
||||
================
|
||||
|
||||
.. automodule:: salt.beacons.adb
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.aix_account module
|
||||
===============================
|
||||
salt.beacons.aix_account
|
||||
========================
|
||||
|
||||
.. automodule:: salt.beacons.aix_account
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.avahi_announce module
|
||||
====================================
|
||||
salt.beacons.avahi_announce
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.beacons.avahi_announce
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.bonjour_announce module
|
||||
====================================
|
||||
salt.beacons.bonjour_announce
|
||||
=============================
|
||||
|
||||
.. automodule:: salt.beacons.bonjour_announce
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=================
|
||||
salt.beacons.btmp
|
||||
=================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
======================
|
||||
salt.beacons.cert_info
|
||||
======================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
======================
|
||||
salt.beacons.diskusage
|
||||
======================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.glxinfo module
|
||||
===========================
|
||||
salt.beacons.glxinfo
|
||||
====================
|
||||
|
||||
.. automodule:: salt.beacons.glxinfo
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.haproxy module
|
||||
===========================
|
||||
salt.beacons.haproxy
|
||||
====================
|
||||
|
||||
.. automodule:: salt.beacons.haproxy
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
====================
|
||||
salt.beacons.inotify
|
||||
====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=====================
|
||||
salt.beacons.journald
|
||||
=====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.junos_rre_keys module
|
||||
====================================
|
||||
salt.beacons.junos_rre_keys
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.beacons.junos_rre_keys
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=================
|
||||
salt.beacons.load
|
||||
=================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
==============================
|
||||
salt.beacons.log_beacon module
|
||||
==============================
|
||||
salt.beacons.log_beacon
|
||||
=======================
|
||||
>>>>>>> doc: remove `module` suffix from descriptions
|
||||
|
||||
.. automodule:: salt.beacons.log_beacon
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.memusage module
|
||||
============================
|
||||
salt.beacons.memusage
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.beacons.memusage
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==========================
|
||||
salt.beacons.napalm_beacon
|
||||
==========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.beacons.network_info
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=============================
|
||||
salt.beacons.network_settings
|
||||
=============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
================
|
||||
salt.beacons.pkg
|
||||
================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.proxy_example module
|
||||
=================================
|
||||
salt.beacons.proxy_example
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.beacons.proxy_example
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.ps module
|
||||
======================
|
||||
salt.beacons.ps
|
||||
===============
|
||||
|
||||
.. automodule:: salt.beacons.ps
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.salt_proxy module
|
||||
==============================
|
||||
salt.beacons.salt_proxy
|
||||
=======================
|
||||
|
||||
.. automodule:: salt.beacons.salt_proxy
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
====================
|
||||
salt.beacons.service
|
||||
====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===============
|
||||
salt.beacons.sh
|
||||
===============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.smartos_imgadm module
|
||||
==================================
|
||||
salt.beacons.smartos_imgadm
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.beacons.smartos_imgadm
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.smartos_vmadm module
|
||||
=================================
|
||||
salt.beacons.smartos_vmadm
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.beacons.smartos_vmadm
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.status module
|
||||
==========================
|
||||
salt.beacons.status
|
||||
===================
|
||||
|
||||
.. automodule:: salt.beacons.status
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.swapusage module
|
||||
=============================
|
||||
salt.beacons.swapusage
|
||||
======================
|
||||
|
||||
.. automodule:: salt.beacons.swapusage
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=============================
|
||||
salt.beacons.telegram_bot_msg
|
||||
=============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===========================
|
||||
salt.beacons.twilio_txt_msg
|
||||
===========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.beacons.watchdog module
|
||||
============================
|
||||
salt.beacons.watchdog
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.beacons.watchdog
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=================
|
||||
salt.beacons.wtmp
|
||||
=================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
========================
|
||||
salt.cloud.clouds.aliyun
|
||||
========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==========================
|
||||
salt.cloud.clouds.azurearm
|
||||
==========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=====================
|
||||
salt.cloud.clouds.clc
|
||||
=====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
============================
|
||||
salt.cloud.clouds.cloudstack
|
||||
============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============================
|
||||
salt.cloud.clouds.digitalocean
|
||||
==============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===============================
|
||||
salt.cloud.clouds.dimensiondata
|
||||
===============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=====================
|
||||
salt.cloud.clouds.ec2
|
||||
=====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=====================
|
||||
salt.cloud.clouds.gce
|
||||
=====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
========================
|
||||
salt.cloud.clouds.gogrid
|
||||
========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.hetzner
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
========================
|
||||
salt.cloud.clouds.joyent
|
||||
========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.libvirt
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
========================
|
||||
salt.cloud.clouds.linode
|
||||
========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=====================
|
||||
salt.cloud.clouds.lxc
|
||||
=====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.msazure
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===========================
|
||||
salt.cloud.clouds.oneandone
|
||||
===========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
============================
|
||||
salt.cloud.clouds.opennebula
|
||||
============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===========================
|
||||
salt.cloud.clouds.openstack
|
||||
===========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
========================
|
||||
salt.cloud.clouds.packet
|
||||
========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===========================
|
||||
salt.cloud.clouds.parallels
|
||||
===========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============================
|
||||
salt.cloud.clouds.profitbricks
|
||||
==============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.proxmox
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=======================
|
||||
salt.cloud.clouds.pyrax
|
||||
=======================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===========================
|
||||
salt.cloud.clouds.qingcloud
|
||||
===========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.saltify
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==========================
|
||||
salt.cloud.clouds.scaleway
|
||||
==========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
===========================
|
||||
salt.cloud.clouds.softlayer
|
||||
===========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============================
|
||||
salt.cloud.clouds.softlayer_hw
|
||||
==============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==============================
|
||||
salt.cloud.clouds.tencentcloud
|
||||
==============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.vagrant
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
============================
|
||||
salt.cloud.clouds.virtualbox
|
||||
============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
========================
|
||||
salt.cloud.clouds.vmware
|
||||
========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=========================
|
||||
salt.cloud.clouds.vultrpy
|
||||
=========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=====================
|
||||
salt.cloud.clouds.xen
|
||||
=====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.docker_events module
|
||||
=================================
|
||||
salt.engines.docker_events
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.engines.docker_events
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
============================
|
||||
salt.engines.fluent
|
||||
============================
|
||||
===================
|
||||
|
||||
.. automodule:: salt.engines.fluent
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==========================
|
||||
salt.engines.http_logstash
|
||||
==========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
==========================
|
||||
salt.engines.ircbot
|
||||
==========================
|
||||
===================
|
||||
|
||||
.. automodule:: salt.engines.ircbot
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.junos_syslog module
|
||||
================================
|
||||
salt.engines.junos_syslog
|
||||
=========================
|
||||
|
||||
.. automodule:: salt.engines.junos_syslog
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.libvirt_events module
|
||||
==================================
|
||||
salt.engines.libvirt_events
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.engines.libvirt_events
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=======================
|
||||
salt.engines.logentries
|
||||
=======================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
============================
|
||||
salt.engines.logstash_engine
|
||||
============================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
==========================
|
||||
salt.engines.napalm_syslog
|
||||
==========================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.reactor module
|
||||
===========================
|
||||
salt.engines.reactor
|
||||
====================
|
||||
|
||||
.. automodule:: salt.engines.reactor
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.redis_sentinel module
|
||||
==================================
|
||||
salt.engines.redis_sentinel
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.engines.redis_sentinel
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.script module
|
||||
==========================
|
||||
salt.engines.script
|
||||
===================
|
||||
|
||||
.. automodule:: salt.engines.script
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.slack module
|
||||
=========================
|
||||
salt.engines.slack
|
||||
==================
|
||||
|
||||
.. automodule:: salt.engines.slack
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=======================
|
||||
salt.engines.sqs_events
|
||||
=======================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.stalekey module
|
||||
============================
|
||||
salt.engines.stalekey
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.engines.stalekey
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=================
|
||||
salt.engines.test
|
||||
=================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.engines.thorium module
|
||||
===========================
|
||||
salt.engines.thorium
|
||||
====================
|
||||
|
||||
.. automodule:: salt.engines.thorium
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
==========================
|
||||
salt.engines.webhook
|
||||
==========================
|
||||
====================
|
||||
|
||||
.. automodule:: salt.engines.webhook
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.executors.direct_call module
|
||||
=================================
|
||||
salt.executors.direct_call
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.executors.direct_call
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.executors.docker module
|
||||
============================
|
||||
salt.executors.docker
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.executors.docker
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.executors.splay module
|
||||
===========================
|
||||
salt.executors.splay
|
||||
====================
|
||||
|
||||
.. automodule:: salt.executors.splay
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
salt.executors.sudo module
|
||||
==========================
|
||||
salt.executors.sudo
|
||||
===================
|
||||
|
||||
.. automodule:: salt.executors.sudo
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
=======================
|
||||
salt.fileserver.azurefs
|
||||
=======================
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue