issues: 521887948

This data as json

id node_id number title user state locked assignee milestone comments created_at updated_at closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
521887948 MDExOlB1bGxSZXF1ZXN0MzQwMTgyODUy 3516 Silence sphinx warnings 14808389 closed 0     32 2019-11-13T00:50:14Z 2019-11-20T02:07:30Z 2019-11-19T15:32:26Z MEMBER   0 pydata/xarray/pulls/3516

This PR tries to silence most sphinx warnings. 5d9d263 is a collection of changes that silence warnings, but they also reduce the readability of the plain text docstrings, so I'd especially appreciate feedback on these.

There are still some warnings left, due to various reasons: * the ufunc warnings are inherited from numpy * some are due to duplicate target names in whats-new.rst (e.g. CF Conventions but also developer names). * two files are not included in any toctree (README.rst and api-hidden.rst) * references in whats-new.rst to labels that were either renamed or removed * conflicting definitions for properties * the CI also lists a lot of broken references to other functions / methods, which do not show for me

To fix these, I would * update the numpy docstrings upstream or find a way to ignore these warnings (probably both) * reference both files from somewhere * track down the labels the references refer to and add them back, or disable the links

but I have no idea how to deal with the duplicate target names, duplicate definitions of properties, where to put the references to both files or if it would be better to leave the broken references broken. I did not look at the long list of broken references the CI shows since I can't reproduce it.

  • [x] short-term fix for #3370
  • [x] Passes black . && mypy . && flake8
  • [ ] Fully documented, including whats-new.rst for all changes and api.rst for new API
 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/3516/reactions",
    "total_count": 1,
    "+1": 1,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 pull

Links from other tables