-
-
Notifications
You must be signed in to change notification settings - Fork 26k
DOC Link directly developer docs in the navbar #22550
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
DOC Link directly developer docs in the navbar #22550
Conversation
There is a downside to this PR. If we are updating the contributing docs in a PR, then the navbar built by the CI would not link to changes in the PR. (It would always link to https://scikit-learn.org/dev/developers/index.html) |
EDIT: sorry I realize now what you mean. But the new rendering for the modified page will be build anyway, right? |
Yup, everything is still built. I updated the PR with a workaround:
|
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 @thomasjpfan !
@thomasjpfan I just realized that there is another link to the contributing guide in the homepage scikit-learn/doc/templates/index.html Line 185 in be2974a
Do you think it is possible to redirect this one too? Thanks! |
Are we fine with showing the following warning? |
If we are linking out of https://scikit-learn.org/stable into https://scikit-learn.org/dev then we need to still show it. The UX issue when one navigates to the Development which links out to "dev" but then wants to look at the current API docs. The only way to do it is to go back, since the navbar is the dev page. I'm not completely happy with this solution and it's a compromise. Here are more alternative:
|
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.
I'm not completely happy with this solution and it's a compromise.
I think it is good enough.
I updated the PR to open a new page when clicking on `Contributing" or "Development". I think this is common practice since we are linking off from the stable website to the dev website. Note: On dev builds or PRs, we still link to the actual page. The linking off to the dev website only happens on stable builds. |
@thomasjpfan, from the artifacts the link opens a new page. Is it expected ? |
It's a bug. It should not open a new page. PR updated with |
Edit: I misread my own comment. Ignore this :) |
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.
I guess we need to backport in 1.0.X to have it immediately available on the stable doc
…ty regarding the toctree, subject to change if maintainers suggest better approaches
Reference Issues/PRs
Fixes #22541
Any other comments?
If merged, I think this should be cherry-picked into
1.0.X
.