Tidy up docs and turn warnings into errors #260
Merged
Conversation
This file contains 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
frozencemetery
suggested changes
Aug 6, 2021
|
@frozencemetery I was sure merging them in any order would have caused a rebase :) Have pushed it to the branch and should be good to go now. |
Signed-off-by: Jordan Borean <jborean93@gmail.com>
frozencemetery
approved these changes
Aug 9, 2021
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.
The docs had a few minor issues with return value indentation, missing extension docs, and some other minor problems. There were also over 200 warnings being output during the generation mostly around unambiguous type selection (
gssapi.OIDvsgssapi.raw.OID). This fixes those warnings and also enables the Sphinx option to treat any future warnings as errors to stop it from building up again.Fixes #143