DOC: Fix various documentation errors and warnings#925
Merged
Conversation
Contributor
Author
|
Test failures seem unrelated to my changes. |
Member
|
Thanks @djhoese 👍 |
Contributor
Author
|
I realized I could just hack the rioxarray source in my installed environment and I can confirm that the changes to |
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
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.
I've been running into a weird issue when trying to document my own project that imports rioxarray. While looking into it I found that there are a ton of warnings and errors in rioxarray's own documentation rendering so I fixed all the ones I was hitting locally:
crs_management.ipynb. Basically the titles went from level 2 to level 4 with no level 3 in between. Further "API Documentation" was defined as level 4 but really I think it should be on the same level as the other sections at 3. I fixed what I could find. This is actually a really big deal as these titles just didn't exist in the rendered HTML because of these issues.Union[Resampling | str]. This is redundant as the|is a Union. I changed this to match the other cases in the modules withUnion[Resampling, str](note the comma instead of the vertical bar). This is the issue I was running into so I'm hoping once this is merged and released that this will just work for my own project.docs/history.rstfor all changes anddocs/rioxarray.rstfor new API