xarray icon indicating copy to clipboard operation
xarray copied to clipboard

Documentation 404 not found for "Suggest Edit" link in "API Reference" pages

Open etienneschalk opened this issue 1 year ago • 1 comments

What happened?

Concrete example: let's say I am currently reading the documentation of DataArray.resample. I would like to have a look at the internals and see the code directly on GitHub.

Screenshot from 2024-02-18 13-32-03

We can see a GitHub icon, with 3 links:

  • Repositry: leads to the home page of the repo: https://github.com/pydata/xarray
  • Suggest edit: leads to a 404 not found as it points to the generated documentation
  • Open issue (generic link to open an issue)

The [source] link does what is expected: it leads to the source code https://github.com/pydata/xarray/blob/main/xarray/core/dataset.py#L10471-L10565

What did you expect to happen?

The second link "Suggest edit" should actually lead to the source code, as the documentation is auto-generated from the docstrings themselves. Maybe it could be renamed like "View source"

Example of other repos having this feature:

Minimal Complete Verifiable Example

N/A

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

N/A

Anything else we need to know?

No response

Environment

N/A

etienneschalk avatar Feb 18 '24 12:02 etienneschalk

Thanks @etienneschalk for reporting and sorry for the delay.

Although the "suggest edit" button should be disabled,

https://github.com/pydata/xarray/blob/b83aef65e711e490403a1e37c4e818d7b6c098bc/doc/conf.py#L388-L392

this obviously doesn't work anymore. I'm no Sphinx expert at all, leaving the debugging to someone else more knowledgeable.

kmuehlbauer avatar Jun 11 '24 06:06 kmuehlbauer