Commit graph

20 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
Christian McHugh
ebf8417c61 Add max-arnold's tests and associated cleanup 2020-03-13 08:29:27 +00:00
Seth House
e61b83c09e Move the local TOC up since it's such a large docstring 2017-05-12 12:03:26 -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
Jacob Hammons
a04cebd48c Remove internal APIs from rest_cherrypy docs.
Refs #28540
2015-12-28 15:26:16 -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
Thomas Jackson
f268bb8b4b Whitespace cleanup 2014-12-11 07:53:20 -08:00
Thomas S Hatch
6aa5b0f858 Merge branch '2014.7' into develop
Conflicts:
	salt/modules/genesis.py
	salt/modules/parted.py
	salt/modules/win_service.py
	salt/runner.py
	salt/states/file.py
	tests/integration/netapi/rest_tornado/test_app.py
2014-11-26 09:24:24 -07:00
rallytime
73f3c0091d Clean up doc build so it doesn't stacktrace
Fixes #18471

- Add zmq.eventloop to mocked modules in doc/conf.py
- Cleaned up rst references in rest_tornado.rst
2014-11-25 15:11:15 -07:00
pengyao
3ffa0dfc6b Url should be '/keys' 2014-11-20 11:16:58 +08:00
Thomas Jackson
6d2fbc8715 Documentation for saltnado 2014-11-13 08:36:29 -08:00
Seth House
9da07584e4 Added missing docs for the /key rest_cherrypy entry point
Should have been part of #16706.
2014-10-29 16:35:04 -05:00
Erik Johnson
f056c9c3fa Fix sphinx build error 2014-09-17 18:00:18 -05:00
Thomas Jackson
c721d9d664 Seperate saltnado_websockets from the rest of the implementation. 2014-06-20 15:10:56 -07:00
Seth House
9f93aaf016 Renamed old autodoc-generated salt-api netapi module filenames 2014-06-19 13:19:24 -06:00
Seth House
1d4057fadf Updated all saltapi import paths to salt.netapi 2014-06-18 20:56:16 -06:00
Seth House
554a612aa4 Renamed netapis to netapi 2014-06-18 20:05:02 -06:00