Edit Button on Documentation page not working for stable

[buti1021]

Description

Navigate to https://pip.pypa.io/en/stable/installation/
Click on the edit icon in the top right corner.

Expected behavior

Github Page to fork/make changes, probably based of the latest version, not of the stable version.

Current behaviour

Github 404 as the commit seems not to be found, works fine when on latest

pip version

current

Python version

n.a.

OS

n.a.

How to Reproduce

n.a.

Output

No response

Code of Conduct

• I agree to follow the PSF Code of Conduct.

[matthewhughes934]

The button links me to https://github.com/pypa/pip/edit/76e82a43f8fb04695e834810df64f2d9a2ff6020/docs/html/installation.md that commit exists and is tagged https://github.com/pypa/pip/releases/tag/24.1.2 (i.e. the latest tag)

The file exists at that path for that commit https://github.com/pypa/pip/blob/76e82a43f8fb04695e834810df64f2d9a2ff6020/docs/html/installation.md, but opening that link the edit button/pencil in the top right is greyed out for me with a mouse-over message:

You must be on a branch to make or propose changes to this file

The docs for latest link to main so I would expect editing to work fine there, since main is a branch. I'm not sure if this worked differently in the past and just stopped, or if this never worked?

For potential solutions, here's what some other projects are doing:

• https://nextjs.org/docs: link just takes you to the file itself (like the working link I shared above) using the tag as a reference. That doesn't 404 but you still can't edit the file since you're not on a branch
• https://coverage.readthedocs.io/en/7.6.0/: does the same
• https://cibuildwheel.pypa.io/en/stable/: edit link points to main. I guess the file contents the user saw from the docs site and the contents they see in GitHub may differ in the case there are changes in main that aren't included in whichever version of the docs they were reading

[matthewhughes934]

🤔 what's adding that link? It's not present when I nox -s docs locally/searching around I don't . Is ReadTheDocs injecting it? https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html suggests you can configure sphinx and then manually add some HTML template, but these docs don't look to be doing that?

Maybe related: readthedocs/readthedocs.org#1820

Digging further, is this just: pradyunsg/furo#668? I see furo is the HTML theme in docs/html/conf.py so I guess that might be adding the button?

[pradyunsg]

Digging further, is this just: pradyunsg/furo#668?

Yes.