This repository has been archived by the owner on Oct 24, 2024. It is now read-only.
Use napoleon instead of numpydoc (xarray doc alignment), and fixes #298
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
etienneschalk
changed the title
8 tasks
|
This looks great, thank you so much @etienneschalk !
I think this is something going wrong in xarray upstream, let's ignore this one for now , see pydata/xarray#8596. All the other warnings are also something to do with xarray-tutorial too.
datatree has no |
TomNicholas
approved these changes
Jan 9, 2024
TomNicholas
reviewed
Jan 9, 2024
| @@ -365,7 +365,7 @@ Breaking changes | |||
| - Removes the option to delete all data in a node by assigning None to the node (in favour of deleting data by replacing | |||
| the node's ``.ds`` attribute with an empty Dataset), or to create a new empty node in the same way (in favour of | |||
| assigning an empty DataTree object instead). | |||
| - Removes the ability to create a new node by assigning a ``Dataset`` object to ``DataTree.__setitem__`. | |||
| - Removes the ability to create a new node by assigning a ``Dataset`` object to ``DataTree.__setitem__``. | |||
There was a problem hiding this comment.
You can also add this PR to whats-new if you want!
etienneschalk
deleted the
eschalk/switch-numpydoc-to-napoleon-for-xarray-doc-alignment
branch
flamingbear
pushed a commit
to flamingbear/rewritten-datatree
that referenced
this pull request
Jan 19, 2024
…rray-contrib/datatree#298 * Use napoleon instead of numpydoc, and fixes * docs * A mypy ignore for pre-commit run --all-files * Updated whats-new.rst
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Motives
This issue aims to fix the build fail in #286
Also, hopefully it can help facilitate the merging into the xarray repo (documentation alignment)
Checklist
[x] Tests addedpre-commit run --all-files[x] New functions/methods are listed inapi.rst[x] Changes are summarized indocs/source/whats-new.rstContents
Related to the issue
numpydocCI dependencypickleshareCI dependency to fix warnings happening duringmake htmllocally, that could probably happen in the CI tooDataTree.imagandDataTree.real, they were raising warnings duringmake htmlnapoleon_prefixed configuration variables inconf.py, from xarray repository: See https://github.com/pydata/xarray/blob/492aa076bd1812af71d68dc221312fb9a199d2d3/doc/conf.py#L118html_static_pathinconf.py- it was raising a warning during doc build (unsure about this ❓)howdoiin index.rst, to fix a warningMisc
.vscodepre-commit run --all-filespassOpen points
html_static_pathinconf.pybe kept? @TomNicholasNotes
Locally, I
pip install pickleshareto remove the warnings related to itThere are still warnings, I did not fix them all when I was unsure how to fix them. Here is the console output of the
make htmlcommand: