Commit graph

17 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
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
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
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
vs
7d84f116e3 fix formatting 2014-10-29 14:37:18 +01:00
vs
4beb56bdbb add wheel.minions to wheel-index 2014-10-29 14:35:13 +01:00
vs
9e63712488 add documentation for wheel.minions 2014-10-29 14:18:23 +01:00
Seth House
14515c3c8b Added generated templates for the new additions 2014-04-17 12:20:07 -06:00
Seth House
d2f057b0fd Combed through all the module types to add recent additions to the docs 2014-04-17 12:16:26 -06:00
Seth House
c8571a5255 Removed nonexistent module docs from TOC 2013-01-23 23:16:16 -07:00
Seth House
8890fe8a71 Removed docs for non-existent module
Fixes #3384
2013-01-23 23:07:34 -07:00
Seth House
0d1cc6e272 Added docs files for new module types 2013-01-11 14:48:30 -07:00
Seth House
91ea50b916 Added missing new modules of varying types 2013-01-11 14:37:01 -07:00
Seth House
95d44b000f Added wheel module documentation 2012-10-29 18:31:55 -06:00