Skip to content

Commit d935d42

Browse files
committed
GA doc string edits, RST updates
I updated the RST files with what we want to show in the compiled docs. I edited 3 of 4 PY source files.
1 parent ba21078 commit d935d42

File tree

8 files changed

+481
-380
lines changed

8 files changed

+481
-380
lines changed

docs/binding.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,30 @@ splunklib.binding
33

44
.. automodule:: splunklib.binding
55

6+
.. autoclass:: Context
7+
:members: connect, delete, get, login, logout, post, request
8+
69
.. autofunction:: connect
710

8-
.. autoclass:: Context
11+
.. autofunction:: namespace
12+
13+
.. autoclass:: UrlEncoded
914
:members:
10-
:inherited-members:
11-
:undoc-members:
1215

13-
.. autofunction:: handler
16+
.. autoclass:: ResponseReader
17+
:members: close, empty, peek, read
1418

1519
.. autoclass:: HTTPError
1620
:members:
17-
:inherited-members:
18-
:undoc-members:
21+
22+
.. autoclass:: HttpLib
23+
:members: delete, get, post, request
24+
25+
.. autofunction:: handler
26+
27+
.. autoclass:: AuthenticationError
28+
:members:
29+
30+
.. autoclass:: NoAuthenticationToken
31+
:members:
32+

docs/client.rst

Lines changed: 80 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,106 +5,141 @@ splunklib.client
55

66
.. autofunction:: connect
77

8-
.. autoclass:: Collection
9-
:members:
8+
.. autoclass:: Service
9+
:members: apps, confs, capabilities, event_types, fired_alerts, indexes, info, inputs, jobs, loggers, messages, modular_input_kinds, parse, restart, restart_required, roles, search, saved_searches, settings, splunk_version, users
1010
:inherited-members:
11-
:undoc-members:
1211

1312
.. autoclass:: Endpoint
14-
:members:
13+
:members: get, post
1514
:inherited-members:
16-
:undoc-members:
1715

1816
.. autoclass:: Entity
19-
:members:
17+
:members: delete, get, post, refresh, access, disable, enable, fields, links, name, namespace, reload, update
2018
:inherited-members:
21-
:undoc-members:
2219

23-
.. autoclass:: Service
24-
:members:
20+
.. autoclass:: ReadOnlyCollection
21+
:members: itemmeta, iter, list, names
2522
:inherited-members:
26-
:undoc-members:
2723

28-
.. autoclass:: AlertGroup
29-
:members:
24+
.. autoclass:: Collection
25+
:members: create, delete
3026
:inherited-members:
31-
:undoc-members:
3227

3328
.. autoclass:: ConfigurationFile
34-
:members:
3529
:inherited-members:
36-
:undoc-members:
3730

3831
.. autoclass:: Configurations
39-
:members:
32+
:members: create, delete
4033
:inherited-members:
41-
:undoc-members:
4234

4335
.. autoclass:: Stanza
44-
:members:
36+
:members: submit
37+
:inherited-members:
38+
39+
.. autoclass:: AlertGroup
40+
:members: alerts, count
41+
:inherited-members:
42+
43+
.. autoclass:: Indexes
44+
:members: default, delete
4545
:inherited-members:
46-
:undoc-members:
4746

4847
.. autoclass:: Index
49-
:members:
48+
:members: attach, attached_socket, clean, disable, enable, roll_hot_buckets, submit, upload
5049
:inherited-members:
51-
:undoc-members:
5250

5351
.. autoclass:: Input
54-
:members:
52+
:members: update
5553
:inherited-members:
56-
:undoc-members:
5754

5855
.. autoclass:: Inputs
59-
:members:
56+
:members: create, delete, itemmeta, kinds, kindpath, list, iter, oneshot
6057
:inherited-members:
61-
:undoc-members:
6258

6359
.. autoclass:: Job
64-
:members:
60+
:members: cancel, disable_preview, enable_preview, events, finalize, is_done, is_ready, name, pause, refresh, results, preview, searchlog, set_priority, summary, timeline, touch, set_ttl, unpause
6561
:inherited-members:
66-
:undoc-members:
6762

6863
.. autoclass:: Jobs
69-
:members:
64+
:members: create, export, itemmeta, oneshot
7065
:inherited-members:
71-
:undoc-members:
7266

7367
.. autoclass:: Loggers
74-
:members:
68+
:members: itemmeta
7569
:inherited-members:
7670

7771
.. autoclass:: Message
78-
:members:
72+
:members: value
73+
:inherited-members:
74+
75+
.. autoclass:: ModularInputKind
76+
:members: arguments, update
7977
:inherited-members:
80-
:undoc-members:
8178

8279
.. autoclass:: SavedSearch
83-
:members:
80+
:members: acknowledge, alert_count, dispatch, fired_alerts, history, update, scheduled_times, suppress, suppressed, unsuppress
8481
:inherited-members:
85-
:undoc-members:
8682

8783
.. autoclass:: SavedSearches
88-
:members:
84+
:members: create
8985
:inherited-members:
90-
:undoc-members:
9186

9287
.. autoclass:: Settings
93-
:members:
88+
:members: update
89+
:inherited-members:
90+
91+
.. autoclass:: User
92+
:members: role_entities
9493
:inherited-members:
95-
:undoc-members:
9694

9795
.. autoclass:: Users
98-
:members:
96+
:members: create, delete
9997
:inherited-members:
100-
:undoc-members:
10198

102-
.. autoclass:: NotSupportedError
103-
:members:
99+
.. autoclass:: Role
100+
:members: grant, revoke
101+
:inherited-members:
102+
103+
.. autoclass:: Roles
104+
:members: create, delete
105+
:inherited-members:
106+
107+
.. autoclass:: Application
108+
:members: setupInfo, package, updateInfo
104109
:inherited-members:
105-
:undoc-members:
110+
111+
.. autoclass:: NoSuchUserException
112+
:members:
113+
114+
.. autoclass:: NoSuchApplicationException
115+
:members:
116+
117+
.. autoclass:: IllegalOperationException
118+
:members:
119+
120+
.. autoclass:: IncomparableException
121+
:members:
122+
123+
.. autoclass:: JobNotReadyException
124+
:members:
125+
126+
.. autoclass:: AmbiguousReferenceException
127+
:members:
128+
129+
.. autoclass:: EntityDeletedException
130+
:members:
131+
132+
.. autoclass:: InvalidNameException
133+
:members:
134+
135+
.. autoclass:: OperationFailedException
136+
:members:
137+
138+
.. autoclass:: NoSuchCapability
139+
:members:
106140

107141
.. autoclass:: OperationError
108142
:members:
109-
:inherited-members:
110-
:undoc-members:
143+
144+
.. autoclass:: NotSupportedError
145+
:members:

docs/data.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ splunklib.data
55

66
.. autofunction:: load
77

8+
.. autoclass:: Record
9+
:members:
10+
811
.. autofunction:: record
912

10-
.. autoclass:: Record
11-
:members:
12-
:undoc-members:

docs/index.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Welcome to the API reference for the Splunk Python SDK, which describes the modules that are included in the Splunk Python SDK.
2-
For more information about the SDK, see the `Developer Portal <http://dev.splunk.com/view/python-sdk/SP-CAAAEBB>`_.
2+
For more information about the SDK, see the `Splunk Developer Portal <http://dev.splunk.com/view/python-sdk/SP-CAAAEBB>`_.
33

44
.. toctree::
55
:maxdepth: 2
@@ -9,16 +9,28 @@ For more information about the SDK, see the `Developer Portal <http://dev.splunk
99

1010
:func:`~splunklib.binding.connect` function
1111

12+
:func:`~splunklib.binding.namespace` function
13+
1214
:class:`~splunklib.binding.Context` class
1315

16+
:class:`~splunklib.binding.ResponseReader` class
17+
18+
:class:`~splunklib.binding.UrlEncoded` class
19+
1420
**Exceptions**
1521

1622
:func:`~splunklib.binding.handler` function
1723

24+
:class:`~splunklib.binding.AuthenticationError` class
25+
26+
:class:`~splunklib.binding.NoAuthenticationToken` class
27+
1828
**Custom HTTP handler**
1929

2030
:class:`~splunklib.binding.HTTPError` class
2131

32+
:class:`~splunklib.binding.HttpLib` class
33+
2234

2335
:doc:`client`
2436
-------------
@@ -37,13 +49,10 @@ For more information about the SDK, see the `Developer Portal <http://dev.splunk
3749

3850
:class:`~splunklib.client.Collection` class
3951

40-
4152
:class:`~splunklib.client.ConfigurationFile` class
4253

4354
:class:`~splunklib.client.Configurations` class
4455

45-
:class:`~splunklib.client.Entity` class
46-
4756
:class:`~splunklib.client.Index` class
4857

4958
:class:`~splunklib.client.Indexes` class
@@ -120,3 +129,5 @@ For more information about the SDK, see the `Developer Portal <http://dev.splunk
120129
--------------
121130

122131
:class:`~splunklib.results.ResultsReader` class
132+
133+
:class:`~splunklib.results.Message` class

docs/results.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ splunklib.results
44
.. automodule:: splunklib.results
55

66
.. autoclass:: ResultsReader
7+
8+
.. autoclass:: Message

0 commit comments

Comments
 (0)