salt/doc/ref/executors/all/salt.executors.docker.rst

salt.executors.docker
=====================

.. automodule:: salt.executors.docker
    :members:
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 ``` 2020-11-29 20:48:37 +00:00			`salt.executors.docker`
			`=====================`
add more documentation for new function 2018-05-19 21:14:40 -05:00
			`.. automodule:: salt.executors.docker`
Revert "add plist to serializers doc index" This reverts commit 7512218a81358785b4a4337f4eb54b7db67cc0a7. 2020-05-18 17:07:42 -07:00			`:members:`