Fix duplicate TOC in Sphinx docs and automate bundling of docs - #365
fantavlik merged 2 commits into
Conversation
Sorry, something went wrong.
…ew 'make docs' command
| 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:: |
There was a problem hiding this comment.
This seemed to be the cause of the duplicate TOC
Sorry, something went wrong.
| [testenv:docs] | ||
| description = invoke sphinx-build to build the HTML docs | ||
| basepython = python3.7 | ||
| deps = sphinx >= 1.7.5, < 2 |
There was a problem hiding this comment.
By running this as a tox command we can let tox install sphinx in a Python 3 environment and skip those steps as part of docs generation
Sorry, something went wrong.
| setenv = SPLUNK_HOME=/opt/splunk | ||
| INPUT_EXAMPLE_UPLOAD=/opt/splunk/var/log/splunk/splunkd_ui_access.log | ||
| whitelist_externals = true | ||
| allowlist_externals = make |
There was a problem hiding this comment.
This tells tox that it's OK to run make in the docs command below, see: https://tox.readthedocs.io/en/latest/example/basic.html?highlight=make#allowing-non-virtualenv-commands
Sorry, something went wrong.
|
I will wait to merge this until @PKing70 has a chance to look at the latest generated docs for v1.6.15 and verifies that the new script is producing sane-looking docs |
Sorry, something went wrong.
Provide easier docs bundling with tox environment and Sphinx installed as part of new 'make docs' command.