Seth House
64b8fb6a81
Added label to the docs for writing execution modules
2014-05-20 23:30:02 -06:00
Chris Rebert
7d1df94bb1
copyedit ref docs
2014-04-30 14:08:31 -07:00
Mike Place
2637fc689f
Docs build cleanly! Yay!
2014-02-26 13:32:33 -07: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
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
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
f12194c146
Change decorator example to setup logging. Closes #10584 .
2014-02-19 09:38:38 -07: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
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
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
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
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
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
Gary Wilson Jr
bd499e5640
Fixed several minor misspellings and acronym capitalizations.
2013-03-18 16:42:57 -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
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
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
Sean Channel
61a0318ae9
delete the word "Facter"
...
seems just fine without it
2012-08-30 14:28:52 -07: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
David Bishop
93be588ebb
add sentence pointing to _modules dir for custom modules
2012-03-17 21:50:16 -04:00
Gordon McAllister
72c2014767
War on typos
...
Also cleanup whitespace and break some long lines
2012-03-14 17:09:19 -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
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
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
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
