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

[docs] fix R API link to point to the current version of docs #4691

Merged
merged 3 commits into from
Oct 25, 2021

Conversation

StrikerRUS
Copy link
Collaborator

@StrikerRUS StrikerRUS commented Oct 17, 2021

Right now R API reference always leads to the latest version of R docs. It wasn't a problem in the past, but recently we have started to provide docs for each LightGBM release. So, it's a problem when user browses docs for let say v3.2.1 version, clicks to R API and silently gets R docs for the master branch.
Refer to #4236 (comment).

Live demo for the PR: https://lightgbm.readthedocs.io/en/r_api_docs/. Note that R API link (both iat the start page and side navbar) leads to https://lightgbm.readthedocs.io/en/r_api_docs/R/reference/.

@StrikerRUS StrikerRUS added the doc label Oct 17, 2021
@StrikerRUS StrikerRUS marked this pull request as ready for review October 18, 2021 22:26
@StrikerRUS StrikerRUS requested a review from jameslamb as a code owner October 18, 2021 22:26
Copy link
Collaborator

@jameslamb jameslamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent change! Sorry it took me a few days to review this one.

I tested at the links you provided and this looks like it's working as expected.

@jameslamb jameslamb merged commit df12c1b into master Oct 25, 2021
@jameslamb jameslamb deleted the r_api_docs branch October 25, 2021 03:28
@StrikerRUS
Copy link
Collaborator Author

@jameslamb No problem at all! Thank you very much for testing.

@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants