Commit graph

26 commits

Author SHA1 Message Date
Pedro Algarvio
6c819439b5 Add a few more nice to have hooks
Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>
2023-02-07 07:10:13 +00:00
Barney Sowood
cd42d4eeef Add netapi_enable_clients process doc
Adds documentation on how to enable netapi client interfaces and
test those once enabled.
2023-01-26 13:04:43 -07:00
Barney Sowood
22f4009188 Rework netapi modules documentation
Reworks the netapi module documentation to make it clearer.

* Updated introduction to make a simpler summary and explain
relationship between netapi modules, NetapiClient and the Python API
* Removes references to protocols not supported by any included netapi
modules (XMPP, XMLRPC)
* Removes outdated reference to situation pre-2014.7.0
* Updates client interfaces section to clarify explanation of client
interfaces, how they relate to other parts of Salt and list the main
interfaces.
* Add configuration section to point to netapi_enable_clients docs and
explain per module configuration.
* Add developing modules section and move NetapiClient class
documentation to seperate page as it isn't relevant for just using
netapi modules.
2023-01-26 13:04:43 -07:00
Barney Sowood
4fb47426c2 Add run function to NetapiClient class docs
Adds the run function to the NetapiClient class docs. The docstring for
the class includes an example using run() but the function wasn't
included in members so in the generate doc the example didn't match any
of the described functions.
2023-01-26 13:04:43 -07:00
Barney Sowood
075d2e1f4c Remove toc link to http tutorial in netapi page
Removes toc link to ../tutorials/http in the netapi index page. The
http modules tutorial is not relevant and I suspect this was added
by mistake.
2023-01-10 13:43:21 -07:00
Barney Sowood
71f689402a Add documentation for netapi_enable_clients
Adds documentation for netapi_enable_clients to the netapi reference
documentation.
2022-12-02 11:47:52 +00:00
Erik Johnson
93ee5ee2b0
Fix all Sphinx warnings
Well, all but one, which we expect to see
2018-05-31 15:28:25 -05:00
rallytime
30e8a66fb0 Merge branch '2016.3' into '2016.11'
Conflicts:
  - salt/netapi/rest_tornado/saltnado.py
  - tests/integration/netapi/rest_tornado/test_app.py
2017-01-16 18:54:14 -07:00
rallytime
d24776f5e9 Merge branch '2015.8' into '2016.3'
Conflicts:
  - conf/master
  - doc/topics/netapi/index.rst
  - salt/netapi/__init__.py
2017-01-15 16:07:55 -07:00
rallytime
34282322c0 Clean up tests and docs for batch execution
Batch execution was removed from NetapiClient and Saltnado in
previous commits. This change is a follow up that removes related
test cases and doc references.
2017-01-09 11:29:34 -07:00
rallytime
c722a18468 Update Carbon versionadded tags to 2016.11.0 in doc/* 2016-10-27 15:26:30 -06:00
rallytime
3d5c160b5d Use Carbon instead of Boron for new develop functions/args/kwargs 2016-08-09 16:07:39 -06:00
rallytime
40cd0ac8fe Merge branch '2016.3' into 'develop'
Conflicts:
  - salt/states/file.py
  - tests/runtests.py
2016-02-25 16:21:15 -07:00
kstreee
53e0b56b13 [saltstack/salt#31194] Add documentation about running multiple salt-api modules, advised by @whiteinge. 2016-02-22 11:35:16 +09:00
rallytime
4baea26c58 Merge branch '2015.8' into '2016.3'
Conflicts:
  - doc/topics/netapi/index.rst
  - salt/modules/win_servermanager.py
  - salt/modules/zypper.py
2016-02-20 12:27:41 -07:00
Seth House
0cfe5d89a0 Update list of netapi clients for autoclass 2016-02-19 13:07:09 -07:00
Jacob Hammons
b192a9ba38 Doc restructuring, organization, and cleanup. Updated the doc navigation. 2016-01-31 20:10:02 -07:00
Seth House
6be5745f61 Add local_subset client to docs 2015-09-17 18:03:04 -06:00
Thomas Jackson
498a612078 Whitespace cleanup
Conflicts:
	doc/topics/cloud/linode.rst
	doc/topics/cloud/misc.rst
	doc/topics/cloud/parallels.rst
	doc/topics/cloud/proxmox.rst

Conflicts:
	doc/topics/development/architecture.rst
	doc/topics/development/translating.rst
2014-12-11 07:53:19 -08:00
rallytime
8dcedf684d Change more affected docs from Helium to 2014.7.0 2014-07-15 17:02:19 -06:00
Seth House
d2f82c8bba Removed incorrect TOC syntax from netapi index 2014-06-20 10:21:18 -06:00
Seth House
8f5e336a16 Added link to the writing netapi modules doc 2014-06-19 13:22:57 -06:00
Seth House
6d09e554e4 Fixed two straggling occurances of APIClient -> NetapiClient 2014-06-19 13:02:16 -06:00
Seth House
1d4057fadf Updated all saltapi import paths to salt.netapi 2014-06-18 20:56:16 -06:00
Seth House
6f112d6eef Updated the netapi modules index to be more clear 2014-06-18 20:19:03 -06:00
Seth House
554a612aa4 Renamed netapis to netapi 2014-06-18 20:05:02 -06:00