Commit graph

15 commits

Author SHA1 Message Date
Daniel A. Wozniak
179e95fa89 docs fixup 2024-04-11 16:22:55 -07:00
Pedro Algarvio
f4549113b1
Update pre-commit hook versions 2024-02-29 12:30:49 +00:00
Pedro Algarvio
6c819439b5 Add a few more nice to have hooks
Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>
2023-02-07 07:10:13 +00:00
Alberto Planas
5c12518d6d transactional_update: add executor 2021-08-24 12:11:21 -04:00
Elias Probst
a9fda57b73 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
```
2021-02-19 08:54:50 -05:00
Pedro Algarvio
5e72e192f9 Blacken docs 2020-06-09 03:37:02 -07:00
Wesley Whetstone
1231b463f5 Revert "add plist to serializers doc index"
This reverts commit 7512218a81.
2020-05-19 10:16:07 -07:00
Wesley Whetstone
3615410955 add plist to serializers doc index 2020-05-19 10:16:07 -07:00
Pavel Skuratovich
cdd7ec02c3 Replace incorrectly used "it's" by "its" 2020-02-26 00:57:58 +03:00
Ch3LL
63962b547a
Merge branch '2018.3' into '2019.2'
Conflicts:
  - salt/states/linux_acl.py
  - salt/transport/ipc.py
2019-03-28 11:10:45 -04:00
Alan Cugler
0b1eb00dc4
Replaced test.ping with test.version
Result of issue #52277

Any where `test.ping` still exists in the docs was left
because of the context in those docs.
2019-03-25 12:09:48 -05:00
Daniel Wallace
b12f80712b
add more documentation for new function 2018-06-04 14:01:33 -05:00
Dmitry Kuzmenko
7a8b644da7 Executors documentation. 2017-05-15 11:41:00 +03:00
rallytime
b866427f59 Add a bunch of missing doc module references
Also added an index.rst file for executors, renamed the
azurearm.rst file (Was misspelled with "azureare"), and
removed the xbps-pkg.rst file since that is an invalid
reference.
2017-01-31 15:12:34 -07:00
jacobhammons
7e95127467 man pages updated (#33307)
sphinx build fixes
doc additions for new modules including thorium
2016-05-17 10:24:44 -06:00