Fix duplicate TOC in Sphinx docs and automate bundling of docs with new 'make docs' command

Author: fantavlik

Makefile

@@ -28,6 +28,14 @@ build_app:
 	@echo "$(ATTN_COLOR)==> build_app $(NO_COLOR)"
 	@python setup.py build dist
 
+.PHONY: docs
+docs:
+	@echo "$(ATTN_COLOR)==> docs $(NO_COLOR)"
+	@rm -rf ./docs/_build
+	@tox -e docs
+	@cd ./docs/_build && zip -r docs_html.zip . -x ".*" -x "__MACOSX"
+	@echo "$(ATTN_COLOR)==> Docs pages can be found at ./docs/_build/html, docs bundle available at ./docs/_build/docs_html.zip"
+
 .PHONY: test
 test:
 	@echo "$(ATTN_COLOR)==> test $(NO_COLOR)"

docs/index.rst

@@ -1,19 +1,6 @@
 Welcome to the API reference for the Splunk SDK for Python, which describes the modules that are included in the SDK.
 For more information, see the `Splunk Developer Portal <http://dev.splunk.com/view/python-sdk/SP-CAAAEBB>`_.
 
-.. toctree::
-   :maxdepth: 2
-   :name: SDK for Python API Reference
-
-   binding
-   client
-   data
-   results
-   modularinput
-   searchcommands
-   searchcommandsvalidators
-
-
 :doc:`binding`
 --------------
 

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = clean,py27,py37
+envlist = clean,docs,py27,py37
 skipsdist = {env:TOXBUILD:false}
 
 [testenv:pep8]
@@ -26,7 +26,7 @@ application-import-names = splunk-sdk-python
 passenv = LANG
 setenv = SPLUNK_HOME=/opt/splunk
          INPUT_EXAMPLE_UPLOAD=/opt/splunk/var/log/splunk/splunkd_ui_access.log
-whitelist_externals = true
+allowlist_externals = make
 deps = pytest
        pytest-cov
        xmlrunner
@@ -41,3 +41,9 @@ commands =
 deps = coverage
 skip_install = true
 commands = coverage erase
+
+[testenv:docs]
+description = invoke sphinx-build to build the HTML docs
+basepython = python3.7
+deps = sphinx >= 1.7.5, < 2
+commands = make -C docs/ html