issues: 2070189273

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
2070189273 I_kwDOAMm_X857ZJTZ 8596 Updated `See also` section in the docstrings broke numpydoc 35924738 open 0     0 2024-01-08T10:47:36Z 2024-01-09T19:24:39Z   CONTRIBUTOR      

What happened?

Hi, I would like to report that https://github.com/pydata/xarray/pull/8311 broke the documentation build of Datashader. Datashader's documentation uses Sphinx and numpydoc to process its docstrings. It turns out (I had no idea) that numpydoc processes more doctrings than I'd have expected, including xarray's ones. The changes in the PR made numpydoc unhappy. To reproduce run:

python3 -m venv .venv source .venv/bin/activate pip install numpydoc python -m numpydoc.hooks.validate_docstrings xarray/core/dataarray.py

You'll get this error:

ValueError: Error parsing See Also entry ':doc:`xarray-tutorial:intermediate/indexing/indexing`'

I'm pretty sure this is not an xarray issue but felt that opening an issue here might be useful for others encountering this issue. Really, feel free to close it.

What did you expect to happen?

No response

Minimal Complete Verifiable Example

No response

MVCE confirmation

  • [ ] Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray.
  • [ ] Complete example — the example is self-contained, including all data and the text of any traceback.
  • [ ] Verifiable example — the example copy & pastes into an IPython prompt or Binder notebook, returning the result.
  • [ ] New issue — a search of GitHub Issues suggests this is not a duplicate.
  • [ ] Recent environment — the issue occurs with the latest version of xarray and its dependencies.

Relevant log output

No response

Anything else we need to know?

No response

Environment

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/8596/reactions",
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 issue

Links from other tables