Skip to content

Commit 8373a1a

Browse files
committed
New index
Expanded the docs TOC.
1 parent a1a2be0 commit 8373a1a

File tree

1 file changed

+72
-150
lines changed

1 file changed

+72
-150
lines changed

docs/index.rst

Lines changed: 72 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -1,165 +1,87 @@
1-
Splunk Software Development Kit for Python
2-
==========================================
3-
4-
Contents:
1+
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>`_.
53

64
.. toctree::
75
:maxdepth: 2
86

9-
splunklib.binding
10-
-----------------
11-
12-
.. automodule:: splunklib.binding
13-
14-
.. autofunction:: connect
15-
16-
.. autoclass:: Context
17-
:members:
18-
:inherited-members:
19-
:undoc-members:
20-
21-
.. autofunction:: handler
22-
23-
.. autoclass:: HTTPError
24-
:members:
25-
:inherited-members:
26-
:undoc-members:
27-
28-
splunklib.client
29-
----------------
30-
31-
.. automodule:: splunklib.client
32-
33-
.. autofunction:: connect
34-
35-
.. autoclass:: Collection
36-
:members:
37-
:inherited-members:
38-
:undoc-members:
39-
40-
.. autoclass:: Endpoint
41-
:members:
42-
:inherited-members:
43-
:undoc-members:
44-
45-
.. autoclass:: Entity
46-
:members:
47-
:inherited-members:
48-
:undoc-members:
49-
50-
.. autoclass:: Service
51-
:members:
52-
:inherited-members:
53-
:undoc-members:
54-
55-
.. autoclass:: AlertGroup
56-
:members:
57-
:inherited-members:
58-
:undoc-members:
59-
60-
.. autoclass:: Conf
61-
:members:
62-
:inherited-members:
63-
:undoc-members:
64-
65-
.. autoclass:: Confs
66-
:members:
67-
:inherited-members:
68-
:undoc-members:
69-
70-
.. autoclass:: Stanza
71-
:members:
72-
:inherited-members:
73-
:undoc-members:
74-
75-
.. autoclass:: Index
76-
:members:
77-
:inherited-members:
78-
:undoc-members:
79-
80-
.. autoclass:: Input
81-
:members:
82-
:inherited-members:
83-
:undoc-members:
84-
85-
.. autoclass:: Inputs
86-
:members:
87-
:inherited-members:
88-
:undoc-members:
89-
90-
.. autoclass:: Job
91-
:members:
92-
:inherited-members:
93-
:undoc-members:
94-
95-
.. autoclass:: Jobs
96-
:members:
97-
:inherited-members:
98-
:undoc-members:
99-
100-
.. autoclass:: Loggers
101-
:members:
102-
:inherited-members:
103-
104-
.. autoclass:: Message
105-
:members:
106-
:inherited-members:
107-
:undoc-members:
108-
109-
.. autoclass:: SavedSearch
110-
:members:
111-
:inherited-members:
112-
:undoc-members:
113-
114-
.. autoclass:: SavedSearches
115-
:members:
116-
:inherited-members:
117-
:undoc-members:
118-
119-
.. autoclass:: Settings
120-
:members:
121-
:inherited-members:
122-
:undoc-members:
123-
124-
.. autoclass:: Users
125-
:members:
126-
:inherited-members:
127-
:undoc-members:
128-
129-
.. autoclass:: NotSupportedError
130-
:members:
131-
:inherited-members:
132-
:undoc-members:
133-
134-
.. autoclass:: OperationError
135-
:members:
136-
:inherited-members:
137-
:undoc-members:
138-
139-
splunklib.data
7+
:doc:`binding`
1408
--------------
1419

142-
.. automodule:: splunklib.data
10+
:func:`~splunklib.binding.connect` function
11+
12+
:class:`~splunklib.binding.Context` class
13+
14+
**Exceptions**
15+
16+
:func:`~splunklib.binding.handler` function
17+
18+
**Custom HTTP handler**
19+
20+
:class:`~splunklib.binding.HTTPError` class
21+
22+
23+
:doc:`client`
24+
-------------
25+
26+
:func:`~splunklib.client.connect` function
27+
28+
:class:`~splunklib.client.Service` class
29+
30+
:class:`~splunklib.client.Endpoint` base class
31+
32+
**Entities and collections**
33+
34+
:class:`~splunklib.client.Entity` base class
35+
36+
:class:`~splunklib.client.Collection` base class
37+
38+
:class:`~splunklib.client.AlertGroup` class
14339

144-
.. autofunction:: load
40+
:class:`~splunklib.client.Conf` class
14541

146-
.. autofunction:: record
42+
:class:`~splunklib.client.Confs` class
14743

148-
.. autoclass:: Record
149-
:members:
150-
:undoc-members:
44+
:class:`~splunklib.client.Stanza` class
15145

152-
splunklib.results
153-
-----------------
46+
:class:`~splunklib.client.Index` class
15447

155-
.. automodule:: splunklib.results
48+
:class:`~splunklib.client.Input` class
15649

157-
.. autoclass:: ResultsReader
50+
:class:`~splunklib.client.Inputs` class
15851

159-
Indices and tables
160-
==================
52+
:class:`~splunklib.client.Job` class
16153

162-
* :ref:`genindex`
163-
* :ref:`modindex`
164-
* :ref:`search`
54+
:class:`~splunklib.client.Jobs` class
55+
56+
:class:`~splunklib.client.Loggers` class
57+
58+
:class:`~splunklib.client.Message` class
59+
60+
:class:`~splunklib.client.SavedSearch` class
61+
62+
:class:`~splunklib.client.SavedSearches` class
63+
64+
:class:`~splunklib.client.Settings` class
65+
66+
:class:`~splunklib.client.Users` class
67+
68+
**Exceptions**
69+
70+
:class:`~splunklib.client.NotSupportedError` class
71+
72+
:class:`~splunklib.client.OperationError` class
73+
74+
75+
:doc:`data`
76+
-----------
77+
78+
:func:`~splunklib.data.load` function
79+
80+
:func:`~splunklib.data.record` function
81+
82+
:class:`~splunklib.data.Record` class
83+
84+
:doc:`results`
85+
--------------
16586

87+
:class:`~splunklib.results.ResultsReader` class

0 commit comments

Comments
 (0)