Commit graph

10 commits

Author SHA1 Message Date
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
rallytime
1fa7c021b3 Add pgjsonb_queue to queue doc index 2016-04-08 09:08:17 -06:00
Jacob Hammons
fd7f7bcddf Updated release notes
Added a shortcut to link to pull requests
Added doc entries for all new modules
removed the unnecessary :undoc-members: option from recent doc module entries
2016-03-14 16:34:22 -06:00
rallytime
4fa80f2d5e Merge branch '2015.8' into 'develop'
Conflicts:
  - doc/ref/states/all/index.rst
  - salt/cloud/__init__.py
  - salt/minion.py
  - salt/modules/file.py
  - salt/modules/guestfs.py
  - salt/modules/ipmi.py
  - salt/modules/osquery.py
  - salt/modules/parted.py
  - salt/modules/seed.py
  - salt/modules/virt.py
  - salt/modules/yumpkg.py
  - salt/modules/zypper.py
  - salt/states/boto_elb.py
  - salt/states/pkg.py
2016-01-26 16:19:39 -07:00
Jonathan Ballet
a329adfb21 Add missing salt.queues.* documentation 2016-01-25 12:19:21 +01: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
Jacob Hammons
7ac98a03b6 Updated module doc index using https://github.com/saltstack/salt/pull/27203 2015-09-22 11:54:34 -06:00