Fix duplicate TOC in Sphinx docs and automate bundling of docs #365
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ew 'make docs' command
84de380 to
65acead
Compare
fantavlik
commented
Jan 29, 2021
docs/index.rst
Outdated
| @@ -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:: | |||
There was a problem hiding this comment.
This seemed to be the cause of the duplicate TOC
fantavlik
commented
Jan 29, 2021
| [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
fantavlik
commented
Jan 29, 2021
| @@ -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 | |||
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
zenmoto
approved these changes
Jan 29, 2021
|
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provide easier docs bundling with tox environment and Sphinx installed as part of new 'make docs' command.