Commit graph

24 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
Megan Wilhite
d8b505ed2f Merge pull request #52368 from mchugh19/doc_tests
Unit test to require execution module documentation
2020-01-19 06:56:24 +00:00
Daniel Wallace
33bb5bfe69
fix use of virtualname
Make sure that the virtualname is included in the actual filename of
core modules.  This will help speed up loading of modules that need to
use the virtualname, so that we hit @depends decorators less.
2019-02-19 13:16:06 -06:00
Max Arnold
d7403dae18 Fix profile outputter docs
Also remove the mention of obsolete "grains" output format.
2018-12-15 18:38:39 +07:00
rallytime
eb61788f87 Merge branch '2016.11' into 'develop'
Conflicts:
  - doc/ref/runners/all/index.rst
  - salt/modules/win_lgpo.py
  - salt/states/dockerio.py
2017-02-01 16:36:45 -07: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
Mircea Ulinic
07c66f3ff8
Table outputter doc 2016-11-15 16:29:30 +00:00
Jacob Hammons
dd21da4992 Add autodoc topics for new modules added in Carbon (#36933)
Module formatting issues
Add list of new Carbon modules to release notes
2016-10-12 09:31:07 -06:00
rallytime
eed0a9d23d Remove the compact outputter
This outputter was originally introduced in the 2014.7 branch, but
quickly regressed and never worked in a released version of Salt. Since
then, its existence has caused much confusion. In addition, this
outputter actually was supposed to accomplish the same thing as setting
"state_verbose" to False. Therefore, it doesn't make sense to maintain
two outputters (this one and the highstate outputter).

Fixes #18614
2016-08-30 14:16:59 -06: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
Erik Johnson
94d55889d7 Resolve merge conflicts 2015-02-28 12:35:25 -06:00
Erik Johnson
a7ba699ad7 remove grains outputter from autosummary 2015-02-27 18:12:18 +01:00
Erik Johnson
abf00abea4 remove the docs' .rst file for deleted grains outputter
See e1f8ea6.
2015-02-27 18:12:18 +01:00
Arnold Bechtoldt
020ca989a3 adding output to doc salt.output reference 2015-01-24 22:38:28 +01:00
Thomas Jackson
f268bb8b4b Whitespace cleanup 2014-12-11 07:53:20 -08:00
Erik Johnson
dcfa621717 Add newline_values_only outputter to toctree 2014-08-07 19:25:03 -05:00
Erik Johnson
b3e42245f6 Better documentation for outputters 2014-05-05 17:50:47 -05:00
Seth House
874301d62f Added no_out, no_return, virt_query outputter module docs 2013-03-29 12:25:37 -06: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
87cef23b34 Added output modules docs 2012-10-29 19:16:25 -06:00