From b59851e5a893a3aa6359d7e9898a0ada2634e14d Mon Sep 17 00:00:00 2001 From: Tim Head Date: Fri, 10 Jan 2025 17:10:44 +0100 Subject: [PATCH 1/2] DOC Point users to pretty conda-forge install page (#30617) --- doc/developers/advanced_installation.rst | 8 ++++---- doc/install_instructions_conda.rst | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/developers/advanced_installation.rst b/doc/developers/advanced_installation.rst index 6ae944bd0305d..ee75579c46405 100644 --- a/doc/developers/advanced_installation.rst +++ b/doc/developers/advanced_installation.rst @@ -59,7 +59,7 @@ feature, code or documentation improvement). instead. #. Install a recent version of Python (3.9 or later at the time of writing) for - instance using Miniforge3_. Miniforge provides a conda-based distribution of + instance using Condaforge_. Conda-forge provides a conda-based distribution of Python and the most popular scientific libraries. If you installed Python with conda, we recommend to create a dedicated @@ -258,8 +258,8 @@ to enable OpenMP support: For Apple Silicon M1 hardware, only the conda-forge method below is known to work at the time of writing (January 2021). You can install the `macos/arm64` -distribution of conda using the `miniforge installer -`_ +distribution of conda using the `conda-forge installer +`_ macOS compilers from conda-forge ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -482,4 +482,4 @@ the base system and these steps will not be necessary. .. _Homebrew: https://brew.sh .. _virtualenv: https://docs.python.org/3/tutorial/venv.html .. _conda environment: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html -.. _Miniforge3: https://github.com/conda-forge/miniforge#miniforge3 +.. _Condaforge: https://conda-forge.org/download/ diff --git a/doc/install_instructions_conda.rst b/doc/install_instructions_conda.rst index fe1c14bbb78d3..0b5a57b747021 100644 --- a/doc/install_instructions_conda.rst +++ b/doc/install_instructions_conda.rst @@ -1,5 +1,5 @@ Install conda using the -`miniforge installers `__ (no +`conda-forge installers `__ (no administrator permission required). Then run: .. prompt:: bash From e16edf15ca432cdaa8c70ace5d562bdbd8a6dc27 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Tue, 28 Jan 2025 10:00:37 +0100 Subject: [PATCH 2/2] DOC Enable the canonical link for docs (#30725) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Loïc Estève --- doc/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 4a5d2a6ec9c6b..e2f1c837a65dd 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -207,6 +207,11 @@ # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = "pydata_sphinx_theme" +# This config option is used to generate the canonical links in the header +# of every page. The canonical link is needed to prevent search engines from +# returning results pointing to old scikit-learn versions. +html_baseurl = "https://scikit-learn.org/stable/" + # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation.