-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
[docs]: fix the edit page buttton link in docs #17933
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, I couldn't find a reference for these options. Is there one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fix and the link! :-)
@hauntsaninja Quick question about how the docs are currently working after the recent PR merge. The current behavior of the docs site is as follows: When we view the latest branch, the "Edit" button is visible. This happens because Sphinx uses the GitHub repository link combined with the branch name to allow editing the specific source file of the documentation. However, when we switch to the stable branch, the "Edit" button disappears. This is expected behavior with Sphinx since the stable docs are released using tags, and tagged releases aren't associated with branches that can be directly edited. IMO, we need to further discuss whether this is the behavior we want or if we need to consider changing how we deploy our docs. |
Feel free to open an issue or more PRs if you have some improvements you'd like to make! :-) |
(Explain how this PR changes mypy.)
fix: #17870
Issue
The current docs
edit
the page button gives a 404.What changes this PR does
This PR edits the sphinx
config.py
and configures the edit button url to themaster
branch of this repository.