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
Pedro Algarvio
580a666f60
Revert "Renamed localemod
module to locale
while enforcing absolute imports."
...
This reverts commit 791dc53ca6
.
2013-08-20 23:43:50 +01:00
Pedro Algarvio
39b87cecfb
Revert "Fixed documentation linking."
...
This reverts commit 758e789d12
.
2013-08-20 23:43:48 +01:00
Pedro Algarvio
77803997f3
Revert "Renamed sysmod
module to sys
while enforcing absolute imports."
...
This reverts commit 174a3e5b6c
.
2013-08-20 23:43:45 +01:00
Pedro Algarvio
174a3e5b6c
Renamed sysmod
module to sys
while enforcing absolute imports.
2013-08-19 17:53:14 +01:00
Pedro Algarvio
758e789d12
Fixed documentation linking.
2013-08-19 17:40:07 +01:00
Pedro Algarvio
791dc53ca6
Renamed localemod
module to locale
while enforcing absolute imports.
2013-08-19 17:01:42 +01:00
Pedro Algarvio
c4c58370d2
Renamed ldapmod
module to ldap
while enforcing absolute imports.
2013-08-19 16:31:27 +01:00
Pedro Algarvio
0f08e6088b
Renamed gentoolkitmod
module gentoolkit
while enforcing absolute imports.
2013-08-19 16:24:01 +01:00
Pedro Algarvio
2f4d82b295
Renamed djangomod
module and state to django
while enforcing absolute imports.
2013-08-19 16:13:38 +01:00
Pedro Algarvio
04e3874b42
Renamed debconfmod
module and state to debconf
while enforcing absolute imports.
2013-08-19 14:17:00 +01:00
Pedro Algarvio
e724e54199
Since the module/state got renamed, let's leave a link pointing to the new names.
2013-08-19 13:53:19 +01:00
Pedro Algarvio
1599cd0ba5
Since there are some links to salt.modules.cmdmod
point the user to the correct module.
2013-08-19 13:49:33 +01:00
Pedro Algarvio
3fa341280b
salt.modules.cmdmod
renamed to salt.modules.cmd
while enforcing absolute imports.
2013-08-19 13:45:56 +01:00
Pedro Algarvio
a1a2b49a72
By enforcing absolute imports, there's no need for module name aliases.
2013-08-19 13:23:46 +01:00
Erik Johnson
7d4739da2f
Audit module documentation (A to D)
...
This commit formats shell examples using bash code-block directives, so
that they get syntax highlighting. It also adds missing doc pages for
the ddns module.
2013-08-14 19:53:09 -05:00
Erik Johnson
16b184bb5f
Add rst pages for new modjk state/module
...
This commit tells sphinx to build doc pages for these new files, and
adds them to the table of contents.
2013-08-13 11:02:44 -05:00
Joseph Hall
ed29fa103a
Merge pull request #6376 from terminalmage/issue6322
...
Add functions to manage file backups
2013-07-27 16:27:13 -07:00
Erik Johnson
c2b2f675c0
Add file.restore_backup, file.delete_backup
...
These functions allow you to restore a backup found with
file.list_backups, as well as remove unwanted backups.
2013-07-27 17:49:55 -05:00
Erik Johnson
13e9444329
Add file.list_backups execution function
...
This commit adds a function that will list the available backups for a
given path.
2013-07-27 14:48:20 -05:00
Paul Brian (lifeisstillgood)
fe4559101e
Trivial doc spelling fix
...
It is trivial but it is my first commit / pull request so useful for
checking the process is correct. And it has a semicolon
2013-07-27 13:07:44 +01:00
Pedro Algarvio
bc28a6276b
Link to python's glossary.
2013-07-23 21:45:26 +01:00
Pedro Algarvio
0df4f2e8d0
Link to the actual python False
constant.
2013-07-23 18:21:01 +01:00
Pedro Algarvio
947f99a007
Link to string
and False
in the python documentation.
2013-07-23 17:55:45 +01:00
Pedro Algarvio
b83a749d60
Link to the dict
on python's typesmapping
and point to a docstring explanation.
2013-07-23 17:20:50 +01:00
Erik Johnson
ce22841d52
Rename pillar.data to pillar.items, add pillar.item
...
This brings function parity between the grains and pillar modules, while
preserving backwards compatibility for pillar.data.
2013-07-22 16:08:57 -05:00
Pedro Algarvio
03f09eb99c
Updated documentation since virtualenv
module and state module were renamed to virtualenv_mod
.
2013-07-20 18:59:49 +01:00
Erik Johnson
87d0c07eb2
Remove ref to salt/modules in module writing docs
...
A beginner is not going to know what this means, so don't muddy the
waters with this info. Besides, new modules should only go in
salt/modules once they are accepted into salt proper. Custom modules
should pretty much always go into _modules.
2013-07-18 12:26:39 -05:00
Erik Johnson
1b876fc53a
Clarify docs on custom types
2013-07-08 21:36:34 -05:00
Chris Rebert
bf03461f00
fix spelling: dependancy ==> dependency
2013-07-05 13:35:53 -07:00
Seth House
3412729a84
Added bsd_shadow and portage_config execution/state module docs
2013-07-03 15:43:42 -06:00
Pedro Algarvio
ce76fd78a4
Quiet sphinx.
2013-06-26 18:29:40 +01:00