fix Edit on GitHub

[keewis]

This uses scanpydoc's github_url jinja filter to fix the github url in our api docs, and to also always point to master (see #4440 (comment)).

This currently does not work because we need support to enable the DONT_OVERWRITE_SPHINX_CONTEXT flag. We also might want to vendor github_url because it is only a small part of scanpydoc.

• Closes DOC: Broken links from generated documentation to github #2821
• Passes isort . && black . && mypy . && flake8

[dcherian]

vendor github_url because it is only a small part of scanpydoc.

👍

[max-sixty]

Amazing! Thanks @keewis !

Shall I email RTD support re DONT_OVERWRITE_SPHINX_CONTEXT or do you want to?

[keewis]

Shall I email RTD support re DONT_OVERWRITE_SPHINX_CONTEXT or do you want to?

sorry for not telling, I already did that immediately after creating the PR

[keewis]

I looked at the source of scanpydoc.rtd_github_links. It seems to be a bit larger than I expected, and is also licensed as GPLv3, so I guess it should be fine to keep it as a docs-only dependency (is vendoring GPLv3-licensed code even possible for non-GPL projects?).

[keewis]

okay, so support enabled the flag, but RTD times out while downloading something in plotting.rst (and not just for this branch). Does anyone know what's going on?

[dcherian]

These natural earth URLs time out sometimes.

It's timing out on the browser for me now: https://naciscdn.org/naturalearth/110m/physical/ne_110m_coastline.zip

[keewis]

yes, it seems https://naciscdn.org is down.

[keewis]

to fix this, should we try to use cartopy_offlinedata?

[dcherian]

Does that help on CI?

[keewis]

not sure, I'm trying that right now

Edit: unfortunately it doesn't (unless I need to configure something?)

Edit: So I guess we have to wait for https://naciscdn.org to respond again?

Edit: see nvkelso/natural-earth-vector#416

[keewis]

naciscdn.org is up again so the build passes and the Edit on Github links are fixed (for injected methods, the link points to the outermost wrapper).

However, since the version is set to master the line numbers github_url determines might be wrong for other versions. Should we remove those?

Apart from that, this should be ready for review?

[shoyer]

Let's keep scanpydoc as a docs only dependency, which I think is the easiest option from a GPL compliance perspective (we don't want to make all of xarray GPL)

[keewis]

if I remember the meeting correctly, this should be ready for merging?

[dcherian]

Thanks @keewis.

[max-sixty]

Thanks @keewis — it's great this is solved 🙏