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
Thomas Jackson
f6cf1ee206
Adding docs for "depends" decorator
2013-06-14 17:19:53 -07:00
Seth House
c5bc3f0475
Added new module docs
2013-06-06 17:05:47 -06:00
Erik Johnson
47946a89f4
Remove old locale module rst file
2013-06-06 17:58:00 -05:00
Erik Johnson
91a26f1550
Update rst docs to reflect rename to salt/modules/localemod.py
...
This updates the rst docs to match the change made in ef90d58
2013-06-06 17:48:59 -05:00
Chris Rebert
cde16f8608
remove deleted modules from docs
2013-05-28 17:24:12 -07:00
Seth House
45fcf66ee1
Added docs files for new modules
2013-04-30 14:16:22 -06:00
Seth House
32f063cb39
Added docs for new execution & state modules
2013-04-30 14:06:16 -06:00
Seth House
4e783da4f5
Added a bunch of new execution modules to the docs
2013-03-29 12:25:37 -06:00
Erik Johnson
57024a8461
Rename pkg.available_version to pkg.latest_version
...
See https://github.com/saltstack/salt/issues/4163#issuecomment-15211619
All refs have been updated, and each pkg provider now has
available_version as a function reference pointing to latest_version.
Sphinx docs also updated so that the available_version function
reference is hidden in the docs.
2013-03-20 21:09:15 -05:00
Thomas S Hatch
fa2ce59539
Merge pull request #4154 from terminalmage/issue4109-2
...
Allow pillar.items to also return pillar data
2013-03-18 23:09:31 -07:00
Gary Wilson Jr
bd499e5640
Fixed several minor misspellings and acronym capitalizations.
2013-03-18 16:42:57 -05:00
Erik Johnson
100053ad7e
Allow pillar.items to also return pillar data
2013-03-17 01:55:32 -05:00
Thomas S Hatch
fff07a3fc0
Merge pull request #3768 from ydavid365/grains-state-doc
...
added grains state module to docs
2013-02-18 09:11:02 -08:00
ydavid365
bc756c69be
added grains state module to docs
2013-02-18 00:11:51 -08:00
ydavid365
18bec175ad
module sp
2013-02-17 23:26:28 -08:00
Thomas S Hatch
96071d8b0d
Remove cluser docs
2013-02-12 11:41:01 -07:00
Erik Johnson
d14d859154
Minor tweaks to doc headings
...
Corrected odd grammar on the Modules doc page, and changed a similar
heading in the States docs to match the same wording.
2013-02-10 22:20:56 -06:00
Erik Johnson
d4b120a003
Replace hard-coded links w/relative ":mod:" links
2013-02-03 14:54:04 -06:00
Erik Johnson
cd5e1ef66c
Rename list_updates to list_upgrades
...
In preparation for #3210 , rename list_updates to list_upgrades. Also,
link list_updates to list_upgrade so that people used to running "zypper
list-updates" from the command line will still see the available
upgrades.
Hide list_updates from sphinx docs.
2013-01-12 22:01:01 -06:00
Seth House
0d1cc6e272
Added docs files for new module types
2013-01-11 14:48:30 -07:00
Seth House
2bc75de0a9
Removed old grub module docs
2013-01-11 14:38:10 -07:00
Seth House
91ea50b916
Added missing new modules of varying types
2013-01-11 14:37:01 -07:00
shadowfax-chc
8216c07b20
Added docs for makeconf module
2013-01-05 02:14:08 -05:00
shadowfax-chc
a1a8126e85
Added docs for gentoolkitmod module
2013-01-02 22:34:26 +00:00
shadowfax-chc
5c6f47501f
Added docs for layman module
2013-01-02 22:31:53 +00:00
shadowfax-chc
4fca5e7d71
Added docs for eix modules
2013-01-02 22:30:43 +00:00
Erik Johnson
5def1dd54c
Updated docs for grains, modules, and states
...
Added links to module function documentation, as well as to
"file_roots", and mentioned the saltutil.sync_* functions. Will probably
do the same for returners and renderers soon. This should help people
navigate through the docs easier.
2012-12-18 23:29:36 -06:00
David Boucha
e2dba0ecae
Add module field list documentation
2012-12-03 11:39:38 -07:00
Seth House
cc7c16957b
Added docs for new modules
2012-12-02 16:09:43 -07:00
