Commit graph

64 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
fkantelberg
ae4d46f842 Add hetzner as cloud provider 2021-02-01 06:41:40 -05:00
Charles Kenney
00af98a23f exclude LinodeAPI class members from docs 2020-09-08 08:13:06 -07: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
Akmod
0ef17ea740
Merge branch 'master' into tenentcloud_201921 2020-01-01 12:19:35 -07:00
ch3ll
539429f623
Deprecate nova cloud module 2019-12-20 14:36:12 -05:00
Tyler Johnson
3321997d9f
added tencentcloud to the toctree and fixed linter 2019-12-11 15:25:44 -07:00
Li Kexian
24c9c1581d
fixed python and doc lint check 2019-12-11 14:35:30 -07:00
Erik Johnson
f89d2ccd30
Clean up Sphinx warnings 2018-06-06 08:42:21 -05:00
rallytime
e312efb5e7
Merge branch '2017.7' into '2018.3'
Conflicts:
  - doc/man/salt-api.1
  - doc/man/salt-call.1
  - doc/man/salt-cloud.1
  - doc/man/salt-cp.1
  - doc/man/salt-key.1
  - doc/man/salt-master.1
  - doc/man/salt-minion.1
  - doc/man/salt-proxy.1
  - doc/man/salt-run.1
  - doc/man/salt-ssh.1
  - doc/man/salt-syndic.1
  - doc/man/salt-unity.1
  - doc/man/salt.1
  - doc/man/salt.7
  - doc/man/spm.1
  - salt/modules/cmdmod.py
  - salt/modules/pillar.py
  - salt/modules/yumpkg.py
  - salt/state.py
  - salt/utils/pkg/rpm.py
  - salt/utils/schedule.py
  - tests/integration/states/test_npm.py
  - tests/integration/states/test_pkgrepo.py
2018-03-27 16:31:55 -04:00
Denys Havrysh
51e6aa54a1
[DOC] Unify cloud modules index header 2018-03-21 17:17:28 +02:00
Daniel Wallace
9c604d7328
add docs for openstack driver 2017-12-05 16:09:31 -07:00
Daniel Wallace
f7d182871e
remove openstack driver 2017-12-05 16:09:30 -07:00
Vernon Cole
4cdb04b409
documentation for vagrant cloud & state 2017-10-11 04:49:47 -06:00
Benedikt Werner
c5dde87d88
Renamed digitalocean cloud module doc file 2017-10-10 18:55:06 +02:00
Daniel Wallace
3bae894306
digitalocean should be one word.
Everything on their webpage is a reference to DigitalOcean
2017-09-19 12:47:16 -06:00
aajdinov
d365888489 Initial commit of oneandone salt cloud driver. 2017-08-17 08:03:01 +00:00
rallytime
a876bcdb8a Merge branch 'nitrogen' into 'develop'
No conflicts.
2017-04-27 10:37:05 -06:00
Daniel Wallace
b60a8d013a remove rackspace from index 2017-04-21 09:23:05 -06:00
Daniel Wallace
559aa1d8b6 remove deprecated firstgen rackspace cloud driver 2017-04-21 08:59:56 -06:00
Raine Curtis
87035e0651 new Xen cloud driver 2017-04-12 14:52:07 -06:00
rallytime
2f74dcf685 Various doc updates to fix warnings in doc build 2017-02-06 16:56:58 -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
Nicole Thomas
9e35f5dd08 Add azurearm module to doc index (#38322) 2016-12-16 14:44:20 -07:00
rallytime
9216e8ad93 Remove deprecated vsphere cloud driver in Carbon release
This driver has been marked for deprecation and removal in Carbon.
Release notes were updated accordingly.

Users will need to use the vmware cloud driver instead.
2016-08-05 16:16:12 -06:00
Nitin Madhok
8e319ea52d Update salt.cloud.clouds.vmware.rst 2016-03-22 22:11:15 -04:00
rallytime
308aa5fd61 Merge branch '2016.3' into 'develop'
Conflicts:
  - conf/master
  - conf/minion
  - doc/ref/proxy/all/index.rst
  - salt/cli/daemons.py
  - salt/modules/key.py
  - salt/modules/reg.py
  - salt/modules/win_pkg.py
  - salt/utils/__init__.py
  - salt/utils/cloud.py
  - tests/unit/daemons_test.py
2016-03-18 10:57:15 -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
LoveIsGrief
0eba4cdf17 Public documentation for salt-cloud virtualbox 2016-02-28 17:29:02 +01:00
Mike Place
efe47eb7e1 Merge pull request #30917 from rallytime/remove-botocore-aws-driver
Remove deprecated botocore_aws driver in Boron release
2016-02-10 12:07:14 -07:00
rallytime
9f55ca34a3 Remove doc references, too! 2016-02-05 11:17:22 -07:00
rallytime
8577a4f528 Remove deprecated libcloud_aws driver in Boron release 2016-02-05 11:13:10 -07:00
rallytime
cdc7957808 Fix some autodoc import warnings from building docs 2016-02-02 12:19:38 -07:00
rallytime
6375aa2be3 Add new dimension data to doc list 2016-02-02 09:00:01 -07:00
Ethan Devenport
de7d1666f6 Updates made after PR review:
* Improved and cleaned up documentation.
* Removed unnecessary namespaces.
* Made to fail when no ssh_host is found.
* Cleared pylint violations.
2016-01-25 18:02:10 +00:00
Ethan Devenport
44491f69cf Adds cloud provider support for ProfitBricks Cloud Computing Infrastructure Services. 2016-01-21 22:52:25 +00:00
Colton Myers
26b6c92975 Merge remote-tracking branch 'upstream/2015.8' into merge-forward-develop
Conflicts:
    doc/conf.py
    salt/config/__init__.py
    salt/modules/rh_ip.py
    salt/pillar/s3.py
    salt/returners/local_cache.py
    salt/states/user.py
    salt/templates/rh_ip/rh7_eth.jinja
2015-09-17 11:10:37 -06:00
Jacob Hammons
d939a38c8c release notes updates 2015-09-14 14:52:14 -06:00
Seth House
7422385e24 Add autosummary-generated docs 2015-07-17 17:53:16 -06:00
Seth House
1210a53685 Add all new modules to autosummary docs 2015-07-17 15:53:13 -06:00
Seth House
6be273d5f3 Removed stormpath_mod and linodepy docs; these were renamed 2015-05-01 14:24:00 -06:00
Seth House
ef3893d4de Updated module index pages for each of the module types 2015-04-03 12:39:13 -06:00
Nitin Madhok
3143a54817 Excluding get_configured_provider() and script() from sphinx 2015-03-30 14:22:23 -04:00
Nitin Madhok
031a78b86d Adding script function to this driver and adding this driver to clouds docs 2015-03-29 23:32:34 -04:00
Nitin Madhok
71c73d3d62 Adding salt.cloud.clouds.vmware to docs 2015-03-26 19:45:14 -04: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