Commit Graph

25 Commits

Author SHA1 Message Date
Erik Johnson
93ee5ee2b0
Fix all Sphinx warnings
Well, all but one, which we expect to see
2018-05-31 15:28:25 -05:00
Jacob Hammons
8ec5d989ad 2015.8.8 release docs 2016-03-23 14:00:30 -06:00
Colton Myers
274464a85b Merge remote-tracking branch 'upstream/2015.5' into merge-forward-2015.8
Conflicts:
    doc/topics/reactor/index.rst
    salt/cloud/clouds/digital_ocean_v2.py
    salt/modules/groupadd.py
    salt/modules/localemod.py
    salt/modules/mysql.py
    salt/modules/useradd.py
    salt/modules/win_pkg.py
    salt/modules/win_useradd.py
    salt/netapi/rest_cherrypy/app.py
    salt/pillar/s3.py
    salt/returners/local_cache.py
    salt/states/htpasswd.py
    salt/states/user.py
2015-09-14 14:39:03 -06:00
rallytime
00fe6a225c Fix minor doc typo in client api 2015-09-07 12:55:39 -06:00
Matt Robenolt
2e55f55c5d Add salt.loader.grain_funcs
Exposes all of the functions that make up all of the grains. This
allows a user to call individual grain functions without collecting
all of them.
2015-05-05 20:12:06 -07:00
Colton Myers
000de95974 Merge remote-tracking branch 'upstream/2015.2' into merge-forward-develop
Conflicts:
    .pylintrc
    doc/ref/runners/all/salt.runners.nacl.rst
    doc/topics/cloud/config.rst
    salt/cli/salt.py
    salt/client/mixins.py
    salt/client/ssh/__init__.py
    salt/loader.py
    salt/minion.py
    salt/modules/cassandra_cql.py
    salt/modules/gpg.py
    salt/modules/grains.py
    salt/modules/iptables.py
    salt/modules/yumpkg.py
    salt/netapi/rest_cherrypy/app.py
    salt/renderers/pyobjects.py
    salt/returners/mysql.py
    salt/runners/jobs.py
    salt/state.py
    salt/states/file.py
    salt/states/service.py
    salt/utils/minions.py
    tests/integration/__init__.py
    tests/integration/netapi/rest_tornado/test_app.py
    tests/integration/states/cmd.py
2015-04-16 12:15:44 -06:00
Seth House
30ad8d99df Add SSHClient to the Python API docs
I'm leaving cmd_sync out on purpose for now until we get eauth support
sorted.
2015-04-07 09:53:02 -06:00
Seth House
786c598f06 Added a cmd method to the Caller() class for consistency with *Clients
This adds a new method to the Caller() class which is intended for use
from the Python API. The existing CLI behavior is untouched.

Whether to use `Caller().function()` or `Caller().sminion.functions`
causes the occasional confusion. Also using `function` parses args and
kwargs in a way intended for use from the CLI (I think) which can cause
unexpected behavior at the Python level.
2015-04-03 20:26:59 -06:00
Steve Groesz
e66a02b18b Update netapi reference
Resolves issue #18760
2014-12-11 18:14:47 -06:00
Seth House
a4cc496bc7 Renamed call_func to cmd for consistency; made compat alias
Added WheelClient() documentation on the non-eauth cmd & async funcs.
2014-07-24 16:08:30 -06:00
Seth House
7f147e1212 Added cmd_sync, cmd_async methods to WheelClient docs 2014-07-24 16:08:29 -06:00
Seth House
6e40307efc Document new cmd_sync, cmd_async RunnerClient methods
Also de-emphasize the direct master_call method. Since master_call is
inconsistent between RunnerClient and WheelClient we should instead
present a single, consistent interface.
2014-07-24 16:08:28 -06:00
Khris Richardson
1acd82f3f1 add sphinx spelling extension. enforce en_us 2014-07-13 13:43:33 -05:00
Seth House
e3947b590c Added note when using the loader to run modules that contact the master
Closes #12732
2014-05-16 18:25:14 -06:00
Seth House
d0a7140ae6 Reorganized the Python API docs to be more Python-centric 2014-05-14 19:58:37 -06:00
Seth House
57b26354dd Fixed incorrect documentation on the master/client config functions
Fleshed out the function docstrings and pulled those into the Python API
docs.
2014-05-14 18:49:29 -06:00
Chris Rebert
7d1df94bb1 copyedit ref docs 2014-04-30 14:08:31 -07:00
Seth House
85c929112c Documented using the loader interface from the Python level 2014-04-18 17:14:35 -06:00
Seth House
9142672749 Updated example for getting minion opts dictionary 2014-02-05 15:20:43 -07:00
Seth House
7b50bd1352 Added cmd_batch to Python API documentation 2014-01-28 12:35:02 -07:00
Seth House
6f22ac72a1 Fleshed out docs for each method in the various *Client() interfaces 2013-12-19 22:57:56 -07:00
Seth House
79ad988fef Fleshed out the Python API docs 2013-12-19 21:40:43 -07:00
Seth House
f051ad477c Added CloudClient to the Python API docs 2013-12-19 21:40:34 -07:00
Seth House
4d3012d9db Removed the "Python API" document in favor of the "Clients" doc
This change moves some docs into class docstrings and some into the
clients/index.rst document.

Fixes #6705
2013-08-15 16:00:02 -06:00
Seth House
d19b10117f Added docs on the client API interfaces 2012-12-02 15:48:03 -07:00