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

ReadTheDocs has no 'stable' version #11385

Open
david-cortes opened this issue Apr 4, 2025 · 6 comments
Open

ReadTheDocs has no 'stable' version #11385

david-cortes opened this issue Apr 4, 2025 · 6 comments

Comments

@david-cortes
Copy link
Contributor

Previously, the readthedocs page had a 'stable' version which pointed to the last stable release.

But there's no such tag anymore, so links like this throw 404:
https://xgboost.readthedocs.io/en/stable/index.html

Image

@trivialfis
Copy link
Member

It was replaced by the release_3.0.0 branch. Accessing xgboost.readthedocs.io should redirect to the release branch automatically.

@david-cortes
Copy link
Contributor Author

It was replaced by the release_3.0.0 branch. Accessing xgboost.readthedocs.io should redirect to the release branch automatically.

That's quite problematic if one wants to link to "docs of a class/function in last XGB release" elsewhere.

Most other libraries have a 'stable' tag, which for example can be used with intersphinx in docs of other libraries that link to some xgboost function or class. Granted, it could be replaced with 'latest', but users of public releases typically would want to look at 'stable' instead.

@trivialfis
Copy link
Member

trivialfis commented Apr 4, 2025

I need to figure out a way to create a stable tag on read the docs and redirect it to release_3.0.0. Previously XGBoost set up a stable git branch, which I couldn't easily update to release_3.0.0 (without force push or remove/recreate).

@trivialfis
Copy link
Member

Opened an issue there: readthedocs/readthedocs.org#12081 .

@hcho3
Copy link
Collaborator

hcho3 commented Apr 4, 2025

By default, RTD uses the latest tag, not the latest branch, as stable.

@trivialfis
Copy link
Member

I re-activated the stable RTD, it's using 2.1.4 tag instead of 3.0.0. @hcho3 Do you know of a way to make it track the release_3.0.0 branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants