Hi @lucyleeow ,

I would love to fix the issue. I am new to open source and looking for contributions. Kindly guide me so I can resolve this.

I was checking the script:

https://github.com/scikit-learn/scikit-learn/blob/20be4dfb50e015ca62c11bc3f4c73ffe4d74c36f/build_tools/update_environments_and_lock_files.py

Which says "Environments are conda environment.yml", also in

https://github.com/scikit-learn/scikit-learn/blob/20be4dfb50e015ca62c11bc3f4c73ffe4d74c36f/build_tools/circle/push_doc.sh

Says

#!/bin/bash
# This script is meant to be called in the "deploy" step defined in
# circle.yml. See https://circleci.com/docs/ for more details.
# The behavior of the script is controlled by environment variable defined
# in the circle.yml in the top level folder of the project.

"circle.yml", Which also does not exist

So this could have been changed to the whole new file update_environments_and_lock_files.py

In that case both documentation should be changed.

Thoughts @glemaitre @adrinjalali

Could this link just be to the file build_tools/circle/doc_environment.yml ? Or link to github search for 'sphinx' within this file?

From what I've seen, SPHINX_VERSION is "min", so that we should look up in sklearn/_min_dependencies.py. I suppose that the search can be like this, which gives

Thanks for all the interest.

@Charlie-XIAO the warning reads:

While we do our best to have the documentation build under as many versions of Sphinx as possible, the different versions tend to behave slightly differently. To get the best results, you should use the same version as the one we used on CircleCI. Look at this github search to know the exact version.

We do not want the min dependency version of Sphinx, we want the version of Sphinx used by CircleCI to build the documentation for scikit-learn (this is also the documentation that can be viewed in doc PRs, see: https://scikit-learn.org/dev/developers/contributing.html#generated-documentation-on-github-actions and for more info on CI see: https://scikit-learn.org/dev/developers/contributing.html#continuous-integration-ci)

It's probably best to wait for a core-dev to suggest the best alternative link.

@lucyleeow My bad, thanks for reminding me. I was looking back a few commits when the CircleCI build was still using get_dep sphinx min which looks for the min version specified in _min_dependencies.py. For the current version, I think we should look up in this GitHub search link, which shows

This search can be confusing because it shows both the min dependency (not what we want) and the version of sphinx that is used to build docs.

I would suggest either:

Could this link just be to the file build_tools/circle/doc_environment.yml ? Or link to github search for 'sphinx' within this file?

Making it a link directly to the file seems cleaner but the search gives you what you are looking for quicker.

Again, probably best to wait for a core-dev to chime in, thank you for your patience.

Sorry about that @lucyleeow, I didn't see that you have already found that file. I will close my PR in favor of your earlier investigation.

I think the issue @rand0wn raised is different from this one, and they did not open a PR. I will open another issue about this.

I think you can keep your PR open and just amend when we know the best alternative link.

@lucyleeow I @ the wrong person previously 😂 (now fixed), it should be in favor of your earlier investigation. Sorry for the confusion.

No problem, happy for you to take this issue.

Thanks for spotting this!

I like the suggestion of using https://github.com/search?q=repo%3Ascikit-learn%2Fscikit-learn+sphinx+path%3Abuild_tools%2Fcircle%2Fdoc_environment.yml&type=code (a search for "sphinx" inside the specific file).