Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC doc build sphinx version link out-dated again #27968

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

Closed
Charlie-XIAO opened this issue Dec 16, 2023 · 1 comment · Fixed by #27970
Closed

DOC doc build sphinx version link out-dated again #27968

Charlie-XIAO opened this issue Dec 16, 2023 · 1 comment · Fixed by #27970
Labels
Documentation Needs Triage Issue requires triage

Comments

@Charlie-XIAO
Copy link
Contributor

Describe the issue linked to the documentation

The link to the sphinx versions for doc build at the end of Building the documentation is again out-dated, with sphinx version unpinned in #27656.

image

image

Suggest a potential alternative/fix

Maybe use this link instead? https://github.com/search?q=repo%3Ascikit-learn%2Fscikit-learn+sphinx+path%3Abuild_tools%2Fcircle%2Fdoc_linux-64_conda.lock&type=code

@Charlie-XIAO Charlie-XIAO added Documentation Needs Triage Issue requires triage labels Dec 16, 2023
@lesteve
Copy link
Member

lesteve commented Dec 17, 2023

It's not that it is outdated but that right now sphinx version is unconstrained, so using the latest sphinx version should be fine. I agree it can be a bit confusing if you are looking for an exact version.

Linking to the lock file could be an option, as I mentioned in #27643 (comment). I just realised that regex is supported by github search so the following link would be clear:
https://github.com/search?q=repo%3Ascikit-learn%2Fscikit-learn+%2F%5C%2Fsphinx-%5B0-9.%5D%2B%2F+path%3Abuild_tools%2Fcircle%2Fdoc_linux-64_conda.lock&type=code

Which gives a single line with sphinx + version highlighted:
image

Originally I was not sure that linking to the lock file was worth it, but using the link with the regex above, I now think it is, so PR more than welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Needs Triage Issue requires triage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants