“Edit this page” → “Edit on GitHub/GitLab/Bitbucket”

[jeanas]

Fixes #1172

Open question: should the “edit-this-page.html” template be renamed?

TODO: add tests (I need to figure out how to write them; help welcome).

[choldgraf]

this seems generally pretty good to me!

For your tests question, I think that you might only need to change the regression tests that are here:

https://github.com/pydata/pydata-sphinx-theme/tree/main/tests/test_build

I suspect that when you run the test suite you'll see errors in the regression tests for some HTML templates in that folder. If you delete the files and re-run, then they will be updated with the changes that are reflected from your PR.

[jeanas]

Thanks for the advice! I have updated the tests, now they also test for the link text.

[12rambau]

Thanks for taking the time to make a PR. For the sake of real estate consistency, can we go one step further and use an icon instead of the provider name? exactly as they are doing in RDT

[choldgraf]

I'm not sure why some jobs were failing, I think there might have been an intermittent error?

My 2 cents on the icon question: I am +1 to icons, though don't feel it is necessary to block this PR on having icons. So I'd suggest that we ask @jeanas if they think this would be simple for them to implement, and if not then we try to merge this with the words and then leave icons to a future improvement / issue.

(if we do implement icons, note that we'll need to include something like an aria-label so that GitHub is written down somewhere)

[jeanas]

@12rambau I’m not sure what you mean exactly for the icons, could you clarify it for me? On RTD, they are displaying “[GitHub icon] Edit on GitHub”, but from the wording of your comment, I have the impression that you mean “Edit on [GitHub icon]”.

Personally, I like the current “[Pencil icon] Edit on GitHub” because there is already a GitHub icon on the top right (for going to the project repository) if you have enabled it.

[drammock]

Personally, I like the current “[Pencil icon] Edit on GitHub” because there is already a GitHub icon on the top right (for going to the project repository) if you have enabled it.

Agreed.

Re: the failing CIs:

There is a linter error, which might mean that your pre-commit hooks aren't set up correctly. See here: https://pydata-sphinx-theme.readthedocs.io/en/latest/community/setup.html#setup-pre-commit The other failures look at first glance like network problems, hopefully transient. Let's see if they fail again on next push.

[12rambau]

you convinced me, let's stick to the pencil icon only ;-)

[jeanas]

Tests should be better now. Also, flake8 rightfully reported a typo <blush>... I've fixed it and amended the test so that it would have caught it.

[drammock]

thx @jeanas !

[jeanas]

Thank you all for your review time!