Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit button on documentation is broken #1365

Closed
gustavi opened this issue Jun 8, 2023 · 2 comments
Closed

Edit button on documentation is broken #1365

gustavi opened this issue Jun 8, 2023 · 2 comments

Comments

@gustavi
Copy link

gustavi commented Jun 8, 2023

  1. Go to https://websockets.readthedocs.io/en/stable/
  2. Click on "edit" icon (screenshot)
  3. HTTP GET on https://github.com/aaugustin/websockets/edit/bf858ac9a6e047c50614d6990a12345e1f38802c/docs/index.rst
  4. Redirect on https://github.com/python-websockets/websockets/edit/bf858ac9a6e047c50614d6990a12345e1f38802c/docs/index.rst
  5. GitHub 404

Note: tags (11.0.3 for example) are also affected.

2 solutions in my mind:

  • Replace "edit" by "blob" in URL which is a common "edit on GitHub" behavior: you keep the specific commit in URL
  • Replace the commit by "master": you keep the edition interface on GitHub

--

image

@aaugustin
Copy link
Member

Thank you for reporting this issue. It is actually an issue with the Furo theme. It was brought up here by another user of Furo: pradyunsg/furo#114 (comment)

Maybe that discussion goes somewhere, or maybe I'll just look for a way to disable the edit button. I isn't used much, if at all.

@aaugustin
Copy link
Member

This issue is now tracked there: pradyunsg/furo#668

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants