Skip to content

Backport docs updates (conda-forge link, canonical URL) to 1.5.x #30728

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 28, 2025
Merged

Backport docs updates (conda-forge link, canonical URL) to 1.5.x #30728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a47de44
DOC Point users to pretty conda-forge install page (#30617)
betatim Jan 10, 2025
0677c7a
DOC Enable the canonical link for docs (#30725)
betatim Jan 28, 2025
c61bbca
CI Limit ninja number of parallel jobs in CircleCI (#30333)
lesteve Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build_tools/circle/build_doc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ show_installed_libraries
# Set parallelism to 3 to overlap IO bound tasks with CPU bound tasks on CI
# workers with 2 cores when building the compiled extensions of scikit-learn.
export SKLEARN_BUILD_PARALLEL=3
pip install -e . --no-build-isolation
pip install -e . --no-build-isolation --config-settings=compile-args="-j4"

echo "ccache build summary:"
ccache -s
Expand Down
5 changes: 5 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions doc/developers/advanced_installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -255,8 +255,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
<https://github.com/conda-forge/miniforge#miniforge>`_
distribution of conda using the `conda-forge installer
<https://conda-forge.org/download/>`_

macOS compilers from conda-forge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -480,6 +480,7 @@ the base system and these steps will not be necessary.
.. _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/

Alternative compilers
=====================
Expand Down
2 changes: 1 addition & 1 deletion doc/install_instructions_conda.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Install conda using the
`miniforge installers <https://github.com/conda-forge/miniforge#miniforge>`__ (no
`conda-forge installers <https://conda-forge.org/download/>`__ (no
administrator permission required). Then run:

.. prompt:: bash
Expand Down
Loading