Commit graph

19 commits

Author SHA1 Message Date
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
Gareth J. Greenaway
a3e5ba47d4 manually run pre-commit 2022-10-05 09:11:43 -07:00
Gareth J. Greenaway
627f0c4a7c Porting PR #51840 to 2019.2.1 2022-10-05 09:11:43 -07:00
Gareth J. Greenaway
17e09acc3c Adding in new files 2021-07-07 14:14:53 -04:00
Gareth J. Greenaway
4aa5e0ba7a Porting #44499 to master 2021-07-07 14:14:53 -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
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
rallytime
c274635933
Fix some doc build warnings 2018-09-17 16:20:05 -04:00
Duncan Mac-Vicar P
f4e239290d Terraform roster module to be used with terraform-provider-salt 2018-08-03 00:06:09 +02:00
Daniel Wallace
92ded7162c
add ssh config doc for rosters 2018-05-07 17:25:38 -05:00
Jacob Hammons
887a415138 Adds new Understanding Jinja topic, and fixes several Jinja doc issues.
Removes the "Full list of builtin ..." from each module reference list, leaving just the module type for scanability.

Refs #12470
Refs #10206
Refs #10480
Refs #23522
Refs #33023
2016-06-13 18:30:42 -06:00
Jacob Hammons
2b7f96bf0e Fixed sphinx build warnings / errors, added autodoc entries for new modules added in Boron 2016-01-19 21:57:45 -07:00
Seth House
fe8f3e0bce Added generated doc for clustershell roster module 2015-04-15 18:34:27 -06:00
Seth House
ef3893d4de Updated module index pages for each of the module types 2015-04-03 12:39:13 -06:00
Seth House
57b1f67daa Added autosummary generated placeholders for the new module docs 2015-03-02 14:07:18 -07:00
Seth House
1382401618 Updated all the module index pages with the latest/newest modules 2015-03-02 13:59:19 -07:00
Thomas Jackson
f268bb8b4b Whitespace cleanup 2014-12-11 07:53:20 -08:00
Seth House
918f12a376 Added roster modules to the documentation 2014-06-30 14:01:48 -06:00