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

Fix edit button on Read the Docs with stable branch builds #668

Open
1 task done
pradyunsg opened this issue Jun 16, 2023 · 0 comments
Open
1 task done

Fix edit button on Read the Docs with stable branch builds #668

pradyunsg opened this issue Jun 16, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@pradyunsg
Copy link
Owner

pradyunsg commented Jun 16, 2023

What's happening?

The current logic for computing the GitHub URLs in Furo, when on RTD is:

{% set url = "https://github.com/" + github_user + "/" + github_repo + "/edit/" + github_version + conf_py_path + pagename + page_source_suffix %}

This differs from sphinx-rtd-theme (https://github.com/readthedocs/sphinx_rtd_theme/blob/9899ee4ee2f547f81e51297dc12317f018e62fdd/sphinx_rtd_theme/breadcrumbs.html#L39) and should be fixed to align with that.

Reproducer

  1. Build Sphinx documentation set on RTD, with a stable branch or tag.
  2. See the edit page button's URL -- it has the commit hash rather than the source ref.

Expectation

The generated URL should point to the source ref.

Code of Conduct

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant