Commit Graph

288 Commits

Author SHA1 Message Date
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
Ryan Lane
1bc840a3a9 Add missing boto docs 2015-02-25 12:50:44 -08:00
Alexander Pyatkin
c408c935a0 Implement Bower execution module 2015-02-21 05:56:20 +00:00
Colton Myers
f00465a8a1 Merge remote-tracking branch 'upstream/2015.2' into merge-forward-develop
Conflicts:
	doc/topics/event/index.rst
	salt/loader.py
	salt/modules/config.py
	salt/modules/cyg.py
	salt/modules/hg.py
	salt/modules/lxc.py
	salt/modules/upstart.py
	salt/states/hg.py
	salt/utils/cloud.py
	salt/utils/dictupdate.py
	salt/utils/schedule.py
	tests/integration/fileserver/gitfs_test.py
	tests/unit/pydsl_test.py
2015-02-18 11:55:29 -07:00
Erik Johnson
93835d3f4e Hide set_pass from lxc state docs 2015-02-10 15:06:46 -06:00
Amir Pakdel
eabb8a262c Added MS SQL execution module 2015-02-03 10:02:09 -05:00
Arnold Bechtoldt
7724073588 adding modules to doc salt.modules reference 2015-01-24 22:30:52 +01:00
Thomas Jackson
e32a7e1ed7 Whitespace cleanup 2014-12-11 07:53:20 -08:00
Nitin Madhok
67fd828708 Adding modules to toctree 2014-12-08 10:34:33 -05:00
Nitin Madhok
93700aa642 Fixing sphinx errors and violations 2014-11-25 15:01:30 -05:00
starzyk1
8101b2a8e7 Documentation fixes for jboss7 and artifactory states/modules 2014-11-20 11:16:57 +01:00
Mike Place
a5e1540f22 Provide a facility for modules to report the reasons they cannot be
loaded.
2014-10-02 15:43:10 -06:00
Thomas S Hatch
3ce955c774 Merge branch '2014.7' into develop
Conflicts:
	salt/cloud/deploy/bootstrap-salt.sh
2014-09-24 12:46:37 -06:00
Erik Johnson
a4413bb27a Improve formatting
Bullet points look better here than an indented section with an enormous
font.
2014-09-23 20:58:26 -05:00
Thomas S Hatch
d6e3e01c6d Merge pull request #15392 from ihrwein/f/add-syslog-ng-modules
F/add syslog ng modules
2014-09-12 10:37:02 -06:00
loz-hurst
9031ea871a Fix broken back ticks in 68301c4 2014-09-11 16:15:35 +01:00
loz-hurst
68301c4339 Updated module documentation for clarification
Added note to say that __salt__ is not available to __virtual__.  Also added link to 'at.py' as an example, since it demonstrates using salt.utils in __virtual__ which the existing examples do not. Tweaked wording to make clear that not all the examples are package managers any more.
2014-09-10 14:35:40 +01:00
btibi
69b0deacf6 syslog_ng: add syslog-ng state and execution modules 2014-08-29 23:20:25 +02:00
Ryan Lane
8048b01562 Initial commit of boto_cloudwatch module and boto_cloudwatch_alarm state 2014-08-25 13:37:47 -06:00
Ryan Lane
75ef59f60f Initial commit of boto_cloudwatch module and boto_cloudwatch_alarm state 2014-08-07 16:11:55 -07:00
Seth House
3164b2164e Added hashutil module to docs index 2014-07-25 20:06:54 -06:00
Seth House
6517e7f378 Added generated new module docs 2014-07-24 15:56:19 -06:00
Seth House
81af51bf50 Added new module docs 2014-07-24 15:28:11 -06:00
David Boucha
a04e3d4a0b make sure twilio_notify shows up in the docs 2014-07-13 00:12:23 -06:00
btibi
851ce0fde4 Add syslog_ng execution module. 2014-07-09 22:42:36 +02:00
Seth House
7725350416 Merge pull request #13811 from lyft/doc-additions
Add docs for boto_elasticache and apache_module
2014-06-27 17:10:10 -06:00
Ryan Lane
bffc4f1fb4 Add missing generated rst 2014-06-11 18:18:31 -07:00
Erik Johnson
ee0d14d989 Add new module/state to toctree 2014-06-11 18:06:12 -05:00
Ryan Lane
16c83d24bf Add docs for boto_elasticache and apache_module 2014-06-11 15:52:31 -07:00
Thomas S Hatch
4979ae7b1d Merge pull request #13167 from terminalmage/varnish-cleanup
Cleanup new varnish module and add to docs
2014-06-03 11:00:03 -06:00
Erik Johnson
2c3789c394 Add varnish module to docs 2014-06-02 11:27:09 -05:00
Joseph Hall
e0b2428f5a Add new postfix module 2014-06-02 10:20:58 -06:00
Seth House
64b8fb6a81 Added label to the docs for writing execution modules 2014-05-20 23:30:02 -06:00
Ryan Lane
92f21c7b05 Adding boto_* modules and states to documentation. 2014-05-20 18:06:17 -04:00
KennethWilke
bd18389507 moar docs, moar betta 2014-05-13 15:07:30 -05:00
Chris Rebert
7d1df94bb1 copyedit ref docs 2014-04-30 14:08:31 -07: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
Joseph Hall
cbe3060b6c Updating docs for etcd 2014-03-25 08:24:15 -06:00
Mike Place
2637fc689f Docs build cleanly! Yay! 2014-02-26 13:32:33 -07:00
Thomas S Hatch
205f17236b Merge pull request #10706 from terminalmage/docs
Clean up img module docs
2014-02-24 13:54:00 -08:00
Erik Johnson
7f0971c2b3 Hide aliased function name 2014-02-24 14:11:54 -06:00
Erik Johnson
775db263eb Add znc module to modules toctree 2014-02-24 13:58:54 -06:00
Erik Johnson
283a1faba1 add automodule file for new znc module 2014-02-24 13:58:44 -06:00
Mike Place
a485eceac9 Fix all broken links in docs. Ignore certain known-good links. Adjust many links that are returning 301.
Conflicts:
	doc/topics/installation/index.rst
2014-02-20 16:16:59 -07:00
Erik Johnson
630f79ae3c Add recent modules to docs 2014-02-20 04:27:05 -06:00
Thomas S Hatch
553a4fe10f Merge pull request #10598 from cachedout/2_19_docfix
2 19 docfix
2014-02-19 19:11:12 -07:00
Mike Place
9ff11cbd56 New module docs. 2014-02-19 16:58:24 -07:00
Mike Place
7001c9dcc3 Big re-write of the modules reference. Standardized on 'execution module' as a term to avoid confusion. Cleaned up a lot of weasel-words and made the phrasing more declarative. 2014-02-19 12:51:53 -07:00
Mike Place
c9b58df5f6 Added more modules to documentation index. 2014-02-19 10:34:11 -07:00
Mike Place
f12194c146 Change decorator example to setup logging. Closes #10584. 2014-02-19 09:38:38 -07:00
Tomas Kral
7c4c543fdd doc: fix references in salt.modules.pkg 2014-02-17 13:54:42 +01:00
Erik Johnson
b69234e744 Alias lowercase versions of functions 2014-02-12 16:45:39 -06:00
Erik Johnson
617c04c6ac Rename apt to aptpkg in sphinx configuration 2014-02-04 16:26:13 -06:00
Erik Johnson
f636d1d4ed Fix refs to yumpkg5 2014-01-17 21:08:44 -06:00
Thomas S Hatch
6c144e003e Log to trace instead of print, @pwaller per #9752 2014-01-16 10:49:41 -07:00
Peter Waller
054fccd3b7 Update index.rst
Fix a pet peeve of mine so that beginners don't repeat the mistake: silencing `ImportError` is evil since you don't know if it came because `dependency_that_sometimes_exists` is unavailable or the `dependency_that_sometimes_exists` tried to import something which was broken.

This can seriously hinder debugging.
2014-01-15 14:04:03 +00:00
Colton Myers
b43b0d5d09 Add more state vs module clarification 2014-01-07 16:55:28 -07:00
Joseph Hall
214843c53b Clarify that execution modules and state modules are not the same thing 2014-01-06 19:57:01 -07:00
Erik Johnson
ddad8760a5 Add new pagerduty module/state to docs 2013-12-25 08:45:26 -06:00
Erik Johnson
4f6d448af5 Add new XMPP module/state to docs 2013-12-24 17:58:09 -06:00
Erik Johnson
a2271cb34c Remove docs references to nzbget
This module was recently removed to salt-contrib.
2013-12-23 13:38:08 -06:00
Erik Johnson
180699ee7d Hide alias functions from docs 2013-12-20 13:40:06 -06:00
Erik Johnson
c88269351b Remove references to yumpkg in documentation 2013-12-13 18:01:34 -06:00
Seth House
e6ed5e2889 Added docs for new execution and state modules 2013-12-12 23:29:56 -07:00
Seth House
e252ee8f8a Updated docs for buildout -> zcbuildout rename 2013-12-12 23:29:56 -07:00
Mathieu Le Marec - Pasquet
228c987b76 feat: buildout support
This fixes #8856.
2013-11-29 18:51:20 +00:00
Jeffrey C. Ollie
b1fb52a680 fix more funcion => function typos 2013-11-15 14:50:17 -06:00
Erik Johnson
2b397ec24c Docs formatting fixes
Format filenames in bullet points and use aliases instead of letting the
"blob" role show the full URL for the filenames.
2013-11-09 15:10:12 -06:00
Erik Johnson
c9b455c9fb add "chocolatey" module to docs 2013-10-18 13:09:54 -05:00
Thomas S Hatch
848bd5fc5e Merge pull request #7885 from loz-hurst/develop
Added note about methods with trailing underscores to module docs.
2013-10-16 10:12:16 -07:00
loz-hurst
91d7b2a346 Added note about methods with trailing underscores to module docs.
Not fantastically impressed with what I've written and welcome for someone else to have a stab at it - trying to rectify that it's not clear from the docs ANYWHERE that, e.g., salt.states.alternatives.set_ must be specified as 'alternatives.set' or 'alternatives: - set' in the sls.  'alternatives.set_' or 'alternatives: - set_' will not work.

As a python coder it's obvious what's going on to avoid the name clash in the source but I wouldn't expect all salt users to be python programmers so it needs mentioning somewhere, imho.
2013-10-16 18:10:02 +01:00
Seth House
b0754813df Added docker execution and state modules to docs 2013-10-16 10:58:04 -06:00
Seth House
fd7fd06ebc Removed docs for lxcdocker execution and state modules 2013-10-16 10:47:12 -06:00
Thomas S Hatch
7d164e687e Merge pull request #7864 from makinacorpus/docker
Docker support
2013-10-15 16:13:39 -07:00
Seth House
069b84fd24 Removed 'sys' from pseudo modules list; is real module now 2013-10-15 16:00:02 -06:00
Seth House
7246864f1b Added new/missing execution modules 2013-10-15 16:00:01 -06:00
Seth House
0f3c0bc8bb Checked in generated docs for freebsdports module and ntp state module 2013-10-15 16:00:01 -06:00
Erik Johnson
277fb1e12e Add freebsdports module to docs 2013-10-15 13:02:27 -05:00
Mathieu Le Marec - Pasquet
7dc46a2bbe Merge remote-tracking branch 's/develop' into docker 2013-10-14 00:52:33 +02:00
Erik Johnson
3ddb416a53 Remove inapplicable exclude-members directive 2013-10-09 21:31:05 -05:00
Erik Johnson
2cb6b1c8a3 Suppress function aliases from appearing in docs 2013-10-09 21:29:05 -05:00
Erik Johnson
46520512a6 Add win_ntp module to docs 2013-10-09 21:00:37 -05:00
Mathieu Le Marec - Pasquet
5bd4667a75 add docker 2013-10-02 21:28:03 +02:00
Erik Johnson
905a8bd62a Update list of pkg providers in docs 2013-09-28 20:03:54 -05:00
Erik Johnson
ac5b5178bf Mask module aliases for freebsdpkg, pkgng modules 2013-09-21 12:01:47 -05:00
Erik Johnson
3b3255ddc4 Add new mac user/group modules to toctree 2013-09-21 12:01:47 -05:00
Erik Johnson
e275ca9921 Fix sphinx build warnings (new modules not in toctree) 2013-09-05 13:43:46 -05:00
Erik Johnson
d05ca4fd63 Fix sphinx build error
The '=' for the header did not match the length of the page title.
2013-09-05 13:25:38 -05:00
Matthew Williams
322b6055b2 docs: lxc and seed modules 2013-09-05 06:24:00 +00:00
Pedro Algarvio
1956a6e5cc Sort modules and states. 2013-08-21 00:10:26 +01:00
Pedro Algarvio
bd002f97da Revert "By enforcing absolute imports, there's no need for module name aliases."
This reverts commit a1a2b49a72.
2013-08-20 23:44:05 +01:00
Pedro Algarvio
9353dcafd3 Revert "salt.modules.cmdmod renamed to salt.modules.cmd while enforcing absolute imports."
This reverts commit 3fa341280b.
2013-08-20 23:44:03 +01:00
Pedro Algarvio
3c523bf35f Revert "Since there are some links to salt.modules.cmdmod point the user to the correct module."
This reverts commit 1599cd0ba5.
2013-08-20 23:44:01 +01:00
Pedro Algarvio
0b9851e2bb Revert "Since the module/state got renamed, let's leave a link pointing to the new names."
This reverts commit e724e54199.
2013-08-20 23:43:59 +01:00
Pedro Algarvio
e894db7ffa Revert "Renamed debconfmod module and state to debconf while enforcing absolute imports."
This reverts commit 04e3874b42.
2013-08-20 23:43:57 +01:00
Pedro Algarvio
d598a8074e Revert "Renamed djangomod module and state to django while enforcing absolute imports."
This reverts commit 2f4d82b295.
2013-08-20 23:43:56 +01:00
Pedro Algarvio
105a81ac27 Revert "Renamed gentoolkitmod module gentoolkit while enforcing absolute imports."
This reverts commit 0f08e6088b.
2013-08-20 23:43:54 +01:00
Pedro Algarvio
6659f0393f Revert "Renamed ldapmod module to ldap while enforcing absolute imports."
This reverts commit c4c58370d2.
2013-08-20 23:43:52 +01:00