Commit Graph

330 Commits

Author SHA1 Message Date
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
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
Seth House
a534cf0b69 Added/updated docs on new/changed execution modules 2012-11-14 12:48:43 -07:00
Seth House
e624126add Added daemontools module docs 2012-10-29 18:31:55 -06:00
Seth House
902cf94512 Replaced ca module docs with tls 2012-10-29 18:31:55 -06:00
Seth House
747c6ff6a8 Normalized the "all" modules pages to use the qualified module term 2012-10-29 18:23:56 -06:00
Seth House
6db5a8f94b Added / updated module docs 2012-10-25 14:36:02 -06:00
Seth House
c5302ae0d6 Added new/missing modules/states to docs TOC & generated files 2012-10-04 18:52:50 -06:00
Sean Channel
61a0318ae9 delete the word "Facter"
seems just fine without it
2012-08-30 14:28:52 -07:00
Clint Savage
54a9fe4d28 documenting the CA module 2012-08-22 17:48:50 -06:00
Seth House
01c654d8f1 Added missing modules/states/renderers docs to reference TOC 2012-07-30 00:53:21 -07:00
Seth House
27f7ff6b4c Updated cmdmod doc with new name 2012-07-25 10:45:18 -07:00
Ulrich Dangel
217c69f2b7 Add debian_service to documentation 2012-07-24 00:53:53 +02:00
Ulrich Dangel
ede5e4ba13 Add augeas module to documentation 2012-07-10 17:08:32 +02:00
Seth House
36effed649 Revert "Merge branch 'doc-autosummary-headings' into develop"
This reverts commit 7997ed4842, reversing
changes made to 83c901a174.
2012-07-09 16:03:40 -07:00
Seth House
753ed3a500 Updated modules/states/renderers/returners with new autosummary layout 2012-06-18 00:45:15 -07:00
Seth House
fca05d214e Updated autosummary template to output headings for the Contents sidebar 2012-06-18 00:42:19 -07:00
Baiju Muthukadan
f09e13187b Add brew & win_pkg to pkg virtual module index 2012-05-31 19:22:37 +05:30
Thomas S Hatch
72ad4bf342 Add win_pkg to the doc index 2012-05-26 09:10:18 -06:00
Thomas S Hatch
8107e4421a Add win_groupadd to module index 2012-05-26 09:05:42 -06:00
Thomas S Hatch
2390c54af0 Add sqlite3 to module docs 2012-05-26 08:58:27 -06:00
Thomas S Hatch
9a9b5ca457 Add reg to doc index 2012-05-26 08:56:06 -06:00
Thomas S Hatch
6775077d78 Add rabbitmq_server to doc index 2012-05-26 08:52:43 -06:00
Thomas S Hatch
371db79ccb Add postgres doc to index 2012-05-26 08:47:50 -06:00
Thomas S Hatch
7a9a6e5ae2 Add osxdesktop to module doc index 2012-05-26 08:44:52 -06:00
Thomas S Hatch
08179311e7 Add launchctl to docs 2012-05-26 08:42:40 -06:00
Thomas S Hatch
945594bed5 Add grub module to doc index 2012-05-26 08:38:45 -06:00
Thomas S Hatch
7dd66e2720 Add freebsdjail to module doc index 2012-05-26 08:35:53 -06:00
Thomas S Hatch
9ca915fcbe Add brew module to docs 2012-05-26 08:33:35 -06:00
Thomas S Hatch
f990ecfdf3 Add aliases to doc index 2012-05-26 08:31:38 -06:00
L.C. Rees
3315dad9e7 documentation updates 2012-05-22 22:43:12 -06:00
Baiju Muthukadan
67fb6bff79 simplify example (__init__ can only return None) 2012-05-14 03:15:42 +05:30
Baiju Muthukadan
8b743099c4 Use reStructuredText syntax in example docstring 2012-05-14 03:15:42 +05:30
Baiju Muthukadan
f0e5b30614 Fix file name typo. s/djando/django 2012-05-11 05:12:49 +05:30
Thomas S Hatch
b70f21988e Add django module rst 2012-05-01 23:34:40 -06:00
Thomas S Hatch
a3822280f2 Add django to index list 2012-05-01 23:33:12 -06:00
Seth House
815b197b9b Updated docs for rh_network module rename to rh_ip 2012-04-25 23:09:11 -06:00
Jeff Hutchins
63393e98ef Merge branch '0.9.8' of git://github.com/saltstack/salt into networkstate
Conflicts:
	doc/ref/modules/all/index.rst
2012-04-03 10:25:30 -06:00
Seth House
9fdc5a6917 Silence autosummary warnings about the virtual modules
This change also explicitly shows which modules are virtual.
2012-03-19 05:59:20 -06:00
Seth House
65fbc41242 Fixed a couple headline underlines 2012-03-19 05:43:10 -06:00
Jeff Schroeder
260f976d73 More doc updates 2012-03-18 17:41:21 -07:00
Jeff Schroeder
6839e8a7fe Adding new windows modules to the docs 2012-03-18 17:41:21 -07:00
David Bishop
544f5bafc6 Merge branch 'develop' of https://github.com/saltstack/salt into develop 2012-03-17 21:50:22 -04:00
David Bishop
93be588ebb add sentence pointing to _modules dir for custom modules 2012-03-17 21:50:16 -04:00
Jeff Schroeder
fabe5ba471 Add docs for the new ruby states and update the cmd one 2012-03-17 18:05:37 -07:00
Jeff Schroeder
f834459c41 Add rst doc files for a bunch of modules 2012-03-17 18:05:08 -07:00
Jeff Schroeder
2fe1aa57ee Add zypper to the virtual pkg module list 2012-03-17 17:57:56 -07:00
Jeff Schroeder
7cf08ed8d2 Rename the debconf salt module to fix conflicts
>>> import debconf
>>> debconf.__file__
'/usr/lib/python2.6/dist-packages/debconf.py'
2012-03-17 16:51:08 -07:00
Jeff Schroeder
565ef6b164 Add some new module docs and update release notes 2012-03-17 16:45:32 -07:00
Jeff Schroeder
40a4edecf4 s/cmd/cmdmod/ in all modules docs 2012-03-17 15:24:38 -07:00
Jeff Schroeder
4eed2d0135 Add rvm and gem modules to the all modules doc index 2012-03-17 15:21:40 -07:00
Jeff Schroeder
1fbde66303 Add upstart to the list of all modules 2012-03-17 15:12:43 -07:00
Gordon McAllister
72c2014767 War on typos
Also cleanup whitespace and break some long lines
2012-03-14 17:09:19 -07:00
Seth House
d5e4b4a94b Moved some of new sys module documentation into the existing doc 2012-02-17 14:44:49 -07:00
Thomas S Hatch
454d9156f3 add module doc for the sys module 2012-02-17 13:08:31 -07:00
Seth House
b5efb163c3 Merge branch 'doc-sys' into develop 2012-02-12 04:36:54 -07:00
Seth House
c98db04b9a Added doc on the `sys` pseudo-module 2012-02-12 04:36:44 -07:00
Seth House
3a5b7a4f02 Added a doc for the pkg virtual module 2012-02-12 04:13:34 -07:00
Bret Palsson
14e9f44c50 Apparently I forgot how git works... Second attempt
- Add modules.rh_network and states.network to documentation
- Add modules.rh_network and states.network to documentation index
- Update copyright year in documentation
- Minor changes to the rh_network module
2012-02-10 00:29:49 -07:00
Bret Palsson
f795c36c3a - Add network states file
- Add modules.rh_network and states.network to documentation
- Add modules.rh_network and states.network to documentation index
- Update copyright year in documentation
- Began work on the network states
- Minor changes to the rh_network module
2012-02-10 00:21:04 -07:00
Seth House
b54d4ee573 Added new modules, states, returners docs 2012-01-15 22:54:23 -07:00
Seth House
98c3e75e8e Added a few missing modules to the module index 2011-11-27 10:43:17 -07:00
Seth House
c55c94aafe Added docs for the yumpkg module to the module list
Added a versionadded directive.
2011-11-26 01:45:36 -07:00
Eric Poelke
9f2cd50a04 Renamed yum.py to yumcmd.py to avoid namespace conflict with the real yum module. Updated list_pkgs to handle any number of packages to be passed in for filtering purposes. Added clean_metadata function to keep options similar to the actual yum cli tool. More enhancements to available_version, now will return the version regardless of the package being an update to existing package or the version of a currently not installed package. 2011-11-22 17:15:45 -08:00
Seth House
dd0c07b7e8 Updated references to modules & returners 2011-11-13 03:25:34 -07:00
Seth House
9cc2c166ac Added all current autosummary-generated stub documentation 2011-11-13 03:25:34 -07:00
Seth House
0639489083 Replace manual & monolithic automodule with individual autosummary 2011-11-13 03:25:34 -07:00
Seth House
ebc777dcd7 Removed local TOC from modules page (redundant with sidebar TOC) 2011-11-12 22:47:36 -07:00
Seth House
f496d8d81a Fixed some rST syntax, links, and other last-minute tweaks 2011-11-06 18:56:41 -07:00
Seth House
39159303c6 Fixed invalid rst syntax 2011-10-30 13:20:31 -06:00
Seth House
a912520cf8 Reorganized and reworded the contents page for better focus
Also moved the TOC to its own doc to provide a complete and
comprehensive overview. Removed some extra and unecessary toctree calls.
2011-10-30 12:41:14 -06:00
Seth House
4f76b47b8c Added a bunch of missing modules 2011-10-16 01:33:48 -06:00
Seth House
a336f6c15f Added shortcuts to hyperlink downloads, source files, and issues 2011-09-25 01:23:16 -06:00
Wieland Hoffmann
cab6bbf223 Fix a typo in /doc/ref/modules/index.rst 2011-07-17 16:13:32 -07:00
Thomas S Hatch
9259c9a59e Add outputter docs 2011-07-09 14:24:54 -06:00
Seth House
5d167c2b7b Customized the default table of contents to show more information
Brought a little more organization to the list of modules and returners
pages.
2011-06-25 01:44:57 -06:00
Thomas S Hatch
a30b1dcf24 Remove modules that don't exist 2011-06-22 20:49:29 -06:00
Thomas S Hatch
552118da8c Add documentation on writing documentation and the __virtual__ function 2011-06-21 22:44:10 -06:00
Thomas S Hatch
3186d38f98 Add module cross calling docs 2011-06-21 21:29:51 -06:00
Seth House
4df7ebd8dd Added placeholder docs for modules/returners/grains/renderers/states 2011-05-27 06:27:52 +08:00