Fix the docs #245
Merged
Fix the docs #245
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
Continuation lines after a :param: must be indented.
Return variable name shouldn't be included via :returns:
Also fixed command.conf spelling of "retainsevents" (not "retains events")
- Indentation issues - Removed ":param:`p`" references. Just using "``p``" instead.
- Moved splunklib.searchcommands.validators into it's own rst file. Not sure if this best. But it makes doc generation exceptions stop. :-)
WARNING: Duplicate explicit target name: "search command style guide". Switched `<>`_ to `<>`__ to links. Frankly, I don't understand the difference, but not more complains.
This doesn't seem ideal, but the prior behavior was that the side bar is ONLY usable on the index. As soon as you click on the sub-page you can see it's name, and nothing else. This makes navigation painful, IMHO. This seems like an improvements, even if not great.
Contributor
|
Thanks so much @lowell80 this is an incredible amount of work! We'll keep poking at CI and hope to get this merged shortly |
shakeelmohamed
approved these changes
Feb 23, 2019
Contributor
|
Thanks so much for this work @lowell80! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I found and corrected a number of minor typos and syntax issues in the docs (as hosted at https://splunk-python-sdk.readthedocs.io/en/master/). On this branch Sphinx can now build the docs without any errors. (Specifically 01558e4 fixes the exceptions occurring during the build, which I suspect is what was causing RTD to says that the docs are "failing")
I split the changes into smaller commits so if there's objections to changes they'd be easier to isolate.