Fix Edit on GitHub link to point to source files#15231
Draft
Aanushka001 wants to merge 1 commit into
Draft
Conversation
Carreau
reviewed
Jun 5, 2026
| import tomllib | ||
|
|
||
| from sphinx_toml import load_into_locals | ||
| from sphinxf_toml import load_into_locals |
Carreau
reviewed
Jun 5, 2026
|
|
||
| # - template_path: Add any paths that contain templates here, relative to this directory. | ||
| # - master_doc: The master toctree document. | ||
| # - master_doc: The master tocture document. |
Carreau
reviewed
Jun 5, 2026
|
|
||
| # Options for texinfo output | ||
| # -------------------------- | ||
| # Options for textinfo output |
Carreau
reviewed
Jun 5, 2026
| ] | ||
|
|
||
| ######################################################################### | ||
| ############################################################ |
Member
|
please undo your unrelated and incorrect changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes the "Edit on GitHub" link displayed on ReadTheDocs documentation pages.
Problem: For auto-generated API documentation pages under
api/generated/, the "Edit on GitHub" link was pointing to non-existent.rstfiles since those pages are dynamically generated from Python source code rather than having their own.rstsource.Fix:
Updated
docs/source/_templates/breadcrumbs.html:api/generated/, the link now maps to the corresponding.pysource file instead of a non-existent.rstfile.super()) is preserved.Updated
docs/source/conf.py:html_contextconfiguration withdisplay_github: Trueand proper repository details to enable "Edit on GitHub" support on ReadTheDocs.