Fix all warnings in Python docs #13789
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
This reverts commit 228c6eab23f8a2a7390e8b99259748056abbf32c.
vyasr
added
3 - Ready for Review
ajschmidt8
reviewed
Aug 1, 2023
3 tasks
ajschmidt8
approved these changes
Aug 3, 2023
ajschmidt8
requested changes
Aug 3, 2023
|
It looks like the build paths are different as a result of the changes in this PR. For example, compare the preview environments below:
I see the same problem on the |
ajschmidt8
reviewed
Aug 3, 2023
| @@ -3,8 +3,9 @@ | |||
|
|
|||
| # You can set these variables from the command line, and also | |||
| # from the environment for the first two. | |||
| SPHINXOPTS ?= | |||
| SPHINXOPTS ?= -n -v | |||
There was a problem hiding this comment.
Is there a reason why these flags don't match the cudf Makefile flags?
Will warnings be treated as errors for dask-cudf in a follow-up PR?
There was a problem hiding this comment.
Yes, I didn't want to also try and fix dask-cudf issues in the same PR. This one is large enough already. I also don't know dask-cudf as well so may want to get someone more familiar to work through those issues.
ajschmidt8
reviewed
Aug 3, 2023
ajschmidt8
approved these changes
Aug 5, 2023
galipremsagar
approved these changes
Aug 5, 2023
|
/merge |
3 tasks
rapids-bot bot
pushed a commit
that referenced
this pull request
Aug 8, 2023
This PR is a follow-up to #13789 that adds specified lists of methods/attributes to some classes; removes redundancy in the autosummary templates we are using and adds documentation explaining how they work; and removes various pieces of outdated code in our conf.py to make it easier to maintain going forward. Authors: - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - Bradley Dice (https://github.com/bdice) - Matthew Roeschke (https://github.com/mroeschke) URL: #13826
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.
Description
The Sphinx documentation has historically been warning-filled, which makes it difficult to identify when there are real issues like missing APIs. This PR fixes all the current issues and converts warnings to errors during the build, ensuring that doc builds are reliable indicators of issues in the future.
I will say that there are a few changes that may not be exactly what we want, particularly in cases of including APIs that may not be documented in exactly the same way in pandas. However, I think we'd be better off merging this PR so that we can get to a 0 warnings state and then work through further improvements in follow-ups where the build will be more robust.
Here is an inexhaustive list of the most significant changes:
Checklist