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] lightgbm.readthedocs.io redirects to v3.3.2 not the latest version available (v3.3.5) #5930

Closed
jaceklaskowski opened this issue Jun 15, 2023 · 4 comments
Labels

Comments

@jaceklaskowski
Copy link
Contributor

https://lightgbm.readthedocs.io/ should redirect to the latest version available (3.3.5 atm).

@jaceklaskowski jaceklaskowski changed the title lightgbm.readthedocs.io redirects to v3.3.2 not the latest version available v3.3.5 lightgbm.readthedocs.io redirects to v3.3.2 not the latest version available (v3.3.5) Jun 15, 2023
@jameslamb jameslamb added the doc label Jun 15, 2023
@jameslamb
Copy link
Collaborator

Thanks so much for reporting that!

I found the relevant configuration in the readthedocs Admin page

image

and updated it to v3.3.5. I now see that page redirecting to v3.3.5 correctly.

curl -I curl -I https://lightgbm.readthedocs.io
HTTP/2 302
date: Thu, 15 Jun 2023 14:32:00 GMT
content-type: text/html; charset=utf-8
content-length: 0
location: https://lightgbm.readthedocs.io/en/v3.3.5/

@jameslamb jameslamb changed the title lightgbm.readthedocs.io redirects to v3.3.2 not the latest version available (v3.3.5) [docs] lightgbm.readthedocs.io redirects to v3.3.2 not the latest version available (v3.3.5) Jun 15, 2023
@jaceklaskowski
Copy link
Contributor Author

Shouldn't it be latest or similar since it's done manually rather than through a readthedocs configuration file or some other automated way?

As said here, RTD does not support Default version through a configuration file 😞

@jameslamb
Copy link
Collaborator

shouldn't it be latest or similar

In this project, latest on RTD points to the docs built from the most recent commit merged to the target branch (master). See e.g. https://lightgbm.readthedocs.io/en/latest/index.html.

I agree with you though... it would be preferable to have the base URL https://lightgbm.readthedocs.io redirect to the docs for the most recent release.

On each new release, we update the tag stable to point to that new release. I just enabled building from that tag on RTD, and changed the settings such that https://lightgbm.readthedocs.io/ now redirects to https://lightgbm.readthedocs.io/en/stable.

curl -I https://lightgbm.readthedocs.io
HTTP/2 302
date: Mon, 19 Jun 2023 06:58:31 GMT
content-type: text/html; charset=utf-8
content-length: 0
location: https://lightgbm.readthedocs.io/en/stable/

So now, to summarize

  • {base_url} = redirects to {base_url}/stable
  • {base_url}/latest = most recent commit on master
  • {base_url}/stable = commit that stable tag points to (most recent release from https://github.com/microsoft/LightGBM/releases)
  • {base_url}/v{n}.{n}.{n} = docs from a specific release

cc @guolinke @shiyu1994 @jmoralez so you're aware of this change to the docs hosting.

Thanks for bringing it to our attention.

@github-actions
Copy link

This issue 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 Sep 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants