docs: hide Edit on GitHub link for autogenerated API pages - #15360
Open
MsfPablo wants to merge 1 commit into
Open
docs: hide Edit on GitHub link for autogenerated API pages#15360MsfPablo wants to merge 1 commit into
MsfPablo wants to merge 1 commit into
Conversation
Adds :github_url: hide metadata to RST files generated by apigen so that the breadcrumbs template suppresses the broken Edit on GitHub link on readthedocs. Closes ipython#11919
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
1 participant
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.
Closes #11919\n\nThe docs/source/_templates/breadcrumbs.html template already suppresses the "Edit on GitHub" link for pages under
api/generated/, but it also respects a:github_url: hidepage metadata flag. This change adds that metadata to the RST files produced bydocs/sphinxext/apigen.pyso the broken edit link is hidden on the autogenerated API pages built by ReadTheDocs.\n\nVerified by runningpython docs/autogen_api.pyin a fresh venv and confirming that generated files start with:github_url: hide.\n\nNote: this change was prepared with assistance from Claude (Anthropic).