Skip to content

Commit a1a2be0

Browse files
aprunedaapruneda
committed
Expanded the TOC for the docs
I created new RST files to expand the TOC you get with the python docs.
1 parent ab286e1 commit a1a2be0

File tree

4 files changed

+146
-0
lines changed

4 files changed

+146
-0
lines changed

‎docs/binding.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
splunklib.binding
2+
-----------------
3+
4+
.. automodule:: splunklib.binding
5+
6+
.. autofunction:: connect
7+
8+
.. autoclass:: Context
9+
:members:
10+
:inherited-members:
11+
:undoc-members:
12+
13+
.. autofunction:: handler
14+
15+
.. autoclass:: HTTPError
16+
:members:
17+
:inherited-members:
18+
:undoc-members:

‎docs/client.rst‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
splunklib.client
2+
----------------
3+
4+
.. automodule:: splunklib.client
5+
6+
.. autofunction:: connect
7+
8+
.. autoclass:: Collection
9+
:members:
10+
:inherited-members:
11+
:undoc-members:
12+
13+
.. autoclass:: Endpoint
14+
:members:
15+
:inherited-members:
16+
:undoc-members:
17+
18+
.. autoclass:: Entity
19+
:members:
20+
:inherited-members:
21+
:undoc-members:
22+
23+
.. autoclass:: Service
24+
:members:
25+
:inherited-members:
26+
:undoc-members:
27+
28+
.. autoclass:: AlertGroup
29+
:members:
30+
:inherited-members:
31+
:undoc-members:
32+
33+
.. autoclass:: Conf
34+
:members:
35+
:inherited-members:
36+
:undoc-members:
37+
38+
.. autoclass:: Confs
39+
:members:
40+
:inherited-members:
41+
:undoc-members:
42+
43+
.. autoclass:: Stanza
44+
:members:
45+
:inherited-members:
46+
:undoc-members:
47+
48+
.. autoclass:: Index
49+
:members:
50+
:inherited-members:
51+
:undoc-members:
52+
53+
.. autoclass:: Input
54+
:members:
55+
:inherited-members:
56+
:undoc-members:
57+
58+
.. autoclass:: Inputs
59+
:members:
60+
:inherited-members:
61+
:undoc-members:
62+
63+
.. autoclass:: Job
64+
:members:
65+
:inherited-members:
66+
:undoc-members:
67+
68+
.. autoclass:: Jobs
69+
:members:
70+
:inherited-members:
71+
:undoc-members:
72+
73+
.. autoclass:: Loggers
74+
:members:
75+
:inherited-members:
76+
77+
.. autoclass:: Message
78+
:members:
79+
:inherited-members:
80+
:undoc-members:
81+
82+
.. autoclass:: SavedSearch
83+
:members:
84+
:inherited-members:
85+
:undoc-members:
86+
87+
.. autoclass:: SavedSearches
88+
:members:
89+
:inherited-members:
90+
:undoc-members:
91+
92+
.. autoclass:: Settings
93+
:members:
94+
:inherited-members:
95+
:undoc-members:
96+
97+
.. autoclass:: Users
98+
:members:
99+
:inherited-members:
100+
:undoc-members:
101+
102+
.. autoclass:: NotSupportedError
103+
:members:
104+
:inherited-members:
105+
:undoc-members:
106+
107+
.. autoclass:: OperationError
108+
:members:
109+
:inherited-members:
110+
:undoc-members:

‎docs/data.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
splunklib.data
2+
--------------
3+
4+
.. automodule:: splunklib.data
5+
6+
.. autofunction:: load
7+
8+
.. autofunction:: record
9+
10+
.. autoclass:: Record
11+
:members:
12+
:undoc-members:

‎docs/results.rst‎

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

0 commit comments

Comments
 (0)