Skip to content

Commit 73c0dae

Browse files
committed
Addressed some docs feedback
1 parent 65acead commit 73c0dae

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ docs:
3333
@echo "$(ATTN_COLOR)==> docs $(NO_COLOR)"
3434
@rm -rf ./docs/_build
3535
@tox -e docs
36-
@cd ./docs/_build && zip -r docs_html.zip . -x ".*" -x "__MACOSX"
36+
@cd ./docs/_build/html && zip -r ../docs_html.zip . -x ".*" -x "__MACOSX"
3737
@echo "$(ATTN_COLOR)==> Docs pages can be found at ./docs/_build/html, docs bundle available at ./docs/_build/docs_html.zip"
3838

3939
.PHONY: test

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
# Custom sidebar templates, maps document names to template names.
139139
#html_sidebars = {
140140
html_sidebars = {
141-
'**': ['localtoc.html', 'globaltoc.html', 'searchbox.html'],
141+
'**': ['globaltoc.html', 'searchbox.html'],
142142
}
143143

144144
# Additional templates that should be rendered to pages, maps page names to

docs/index.rst

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

4+
.. toctree::
5+
:maxdepth: 2
6+
:name: SDK for Python API Reference
7+
8+
binding
9+
client
10+
data
11+
results
12+
modularinput
13+
searchcommands
14+
searchcommandsvalidators
15+
16+
417
:doc:`binding`
518
--------------
619

0 commit comments

Comments
 (0)