8000 DOC Update news footer for 1.2.1 (#25472) (#25473) · scikit-learn/scikit-learn@ff1023f · GitHub
[go: up one dir, main page]
Skip to content

Commit ff1023f

Browse files
thomasjpfanjjerphanlesteve
authored
DOC Update news footer for 1.2.1 (#25472) (#25473)
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
1 parent e58f36c commit ff1023f

11 files changed

+71
-196
lines changed

‎.circleci/config.yml

Lines changed: 54 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,78 @@
11
version: 2.1
22

3-
# Parameters required to trigger the execution
4-
# of the "doc-min-dependencies" and "doc" jobs
5-
parameters:
6-
GITHUB_RUN_URL:
7-
type: string
8-
default: "none"
9-
103
jobs:
114
doc-min-dependencies:
125
docker:
136
- image: cimg/python:3.8.12
147
environment:
15-
- GITHUB_ARTIFACT_URL: << pipeline.parameters.GITHUB_RUN_URL >>/doc-min-dependencies.zip
8+
- MKL_NUM_THREADS: 2
9+
- OPENBLAS_NUM_THREADS: 2
10+
- CONDA_ENV_NAME: testenv
11+
- LOCK_FILE: build_tools/circle/doc_min_dependencies_linux-64_conda.lock
12+
# Sphinx race condition in doc-min-dependencies is causing job to stall
13+
# Here we run the job serially
14+
- SPHINX_NUMJOBS: 1
1615
steps:
1716
- checkout
18-
- run: bash build_tools/circle/download_documentation.sh
17+
- run: ./build_tools/circle/checkout_merge_commit.sh
18+
- restore_cache:
19+
key: v1-doc-min-deps-datasets-{{ .Branch }}
20+
- restore_cache:
21+
keys:
22+
- doc-min-deps-ccache-{{ .Branch }}
23+
- doc-min-deps-ccache
24+
- run: ./build_tools/circle/build_doc.sh
25+
- save_cache:
26+
key: doc-min-deps-ccache-{{ .Branch }}-{{ .BuildNum }}
27+
paths:
28+
- ~/.ccache
29+
- ~/.cache/pip
30+
- save_cache:
31+
key: v1-doc-min-deps-datasets-{{ .Branch }}
32+
paths:
33+
- ~/scikit_learn_data
1934
- store_artifacts:
2035
path: doc/_build/html/stable
2136
destination: doc
37+
- store_artifacts:
38+
path: ~/log.txt
39+
destination: log.txt
2240

2341
doc:
2442
docker:
2543
- image: cimg/python:3.8.12
2644
environment:
27-
- GITHUB_ARTIFACT_URL: << pipeline.parameters.GITHUB_RUN_URL >>/doc.zip
45+
- MKL_NUM_THREADS: 2
46+
- OPENBLAS_NUM_THREADS: 2
47+
- CONDA_ENV_NAME: testenv
48+
- LOCK_FILE: build_tools/circle/doc_linux-64_conda.lock
2849
steps:
2950
- checkout
30-
- run: bash build_tools/circle/download_documentation.sh
51+
- run: ./build_tools/circle/checkout_merge_commit.sh
52+
- restore_cache:
53+
key: v1-doc-datasets-{{ .Branch }}
54+
- restore_cache:
55+
keys:
56+
- doc-ccache-{{ .Branch }}
57+
- doc-ccache
58+
- run: ./build_tools/circle/build_doc.sh
59+
- save_cache:
60+
key: doc-ccache-{{ .Branch }}-{{ .BuildNum }}
61+
paths:
62+
- ~/.ccache
63+
- ~/.cache/pip
64+
- save_cache:
65+
key: v1-doc-datasets-{{ .Branch }}
66+
paths:
67+
- ~/scikit_learn_data
3168
- store_artifacts:
3269
path: doc/_build/html/stable
3370
destination: doc
34-
# Persists the generated documentation, so that it
35-
# can be attached and deployed in the "deploy" job
71+
- store_artifacts:
72+
path: ~/log.txt
73+
destination: log.txt
74+
# Persists generated documentation so that it can be attached and deployed
75+
# in the 'deploy' step.
3676
- persist_to_workspace:
3777
root: doc/_build/html
3878
paths: .
@@ -54,36 +94,12 @@ jobs:
5494
bash build_tools/circle/push_doc.sh doc/_build/html/stable
5595
fi
5696
57-
# This noop job is required for the pipeline to exist, so that the
58-
# documentation related jobs can be triggered.
59-
noop:
60-
docker:
61-
- image: cimg/python:3.8.12
62-
steps:
63-
- run: |
64-
echo "This is no-op job for the pipeline to exist, so that it triggers "
65-
echo "Circle CI jobs pushing the artifacts of the documentation built "
66-
echo "via GitHub actions."
67-
6897
workflows:
6998
version: 2
70-
7199
build-doc-and-deploy:
72-
when:
73-
not:
74-
equal: [ "none", << pipeline.parameters.GITHUB_RUN_URL >> ]
75-
# The jobs should run only when triggered by the workflow
76100
jobs:
77-
- doc-min-dependencies
78101
- doc
102+
- doc-min-dependencies
79103
- deploy:
80104
requires:
81105
- doc
82-
83-
noop:
84-
when:
85-
equal: [ "none", << pipeline.parameters.GITHUB_RUN_URL >> ]
86-
# Prevent double execution of this job: on push
87-
# by default and when triggered by the workflow
88-
jobs:
89-
- noop

‎.github/workflows/build-docs.yml

Lines changed: 0 additions & 75 deletions
This file was deleted.

‎.github/workflows/trigger-hosting.yml

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎build_tools/github/build_doc.sh renamed to ‎build_tools/circle/build_doc.sh

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,12 @@ set -e
1616
# If the inspection of the current commit fails for any reason, the default
1717
# behavior is to quick build the documentation.
1818

19+
# defines the get_dep and show_installed_libraries functions
20+
source build_tools/shared.sh
21+
1922
if [ -n "$GITHUB_ACTION" ]
2023
then
21-
# Map the variables for the new documentation builder to the old one
24+
# Map the variables from Github Action to CircleCI
2225
CIRCLE_SHA1=$(git log -1 --pretty=format:%H)
2326

2427
CIRCLE_JOB=$GITHUB_JOB
@@ -169,11 +172,12 @@ ccache -M 512M
169172
export CCACHE_COMPRESS=1
170173

171174
# pin conda-lock to latest released version (needs manual update from time to time)
172-
mamba install conda-lock==1.0.5 -y
175+
mamba install "$(get_dep conda-lock min)" -y
176+
173177
conda-lock install --log-level WARNING --name $CONDA_ENV_NAME $LOCK_FILE
174178
source activate $CONDA_ENV_NAME
175179

176-
mamba list
180+
show_installed_libraries
177181

178182
# Set parallelism to 3 to overlap IO bound tasks with CPU bound tasks on CI
179183
# workers with 2 cores when building the compiled extensions of scikit-learn.
@@ -185,12 +189,18 @@ ccache -s
185189

186190
export OMP_NUM_THREADS=1
187191

192+
# Avoid CI job getting killed because it uses too much memory
193+
if [[ -z $SPHINX_NUMJOBS ]]; then
194+
export SPHINX_NUMJOBS=2
195+
fi
196+
188197
if [[ "$CIRCLE_BRANCH" =~ ^main$ && -z "$CI_PULL_REQUEST" ]]
189198
then
190199
# List available documentation versions if on main
191200
python build_tools/circle/list_versions.py > doc/versions.rst
192201
fi
193202

203+
194204
# The pipefail is requested to propagate exit code
195205
set -o pipefail && cd doc && make $make_args 2>&1 | tee ~/log.txt
196206

‎build_tools/github/doc_environment.yml renamed to ‎build_tools/circle/doc_environment.yml

File renamed without changes.

‎build_tools/github/doc_linux-64_conda.lock renamed to ‎build_tools/circle/doc_linux-64_conda.lock

File renamed without changes.

‎build_tools/github/doc_min_dependencies_environment.yml renamed to ‎build_tools/circle/doc_min_dependencies_environment.yml

File renamed without changes.

‎build_tools/github/doc_min_dependencies_linux-64_conda.lock renamed to ‎build_tools/circle/doc_min_dependencies_linux-64_conda.lock

File renamed without changes.

‎build_tools/github/trigger_hosting.sh

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎build_tools/update_environments_and_lock_files.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ def remove_from(alist, to_remove):
241241
},
242242
{
243243
"build_name": "doc_min_dependencies",
244-
"folder": "build_tools/github",
244+
"folder": "build_tools/circle",
245245
"platform": "linux-64",
246246
"channel": "conda-forge",
247247
"conda_dependencies": common_dependencies_without_coverage
@@ -276,7 +276,7 @@ def remove_from(alist, to_remove):
276276
},
277277
{
278278
"build_name": "doc",
279-
"folder": "build_tools/github",
279+
"folder": "build_tools/circle",
280280
"platform": "linux-64",
281281
"channel": "conda-forge",
282282
"conda_dependencies": common_dependencies_without_coverage

‎doc/templates/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,8 @@ <h4 class="sk-landing-call-header">News</h4>
166166
<li><strong>On-going development:</strong>
167167
<a href="https://scikit-learn.org/dev/whats_new.html"><strong>What's new</strong> (Changelog)</a>
168168
</li>
169+
<li><strong>January 2023.</strong> scikit-learn 1.2.1 is available for download (<a href="whats_new/v1.2.html#version-1-2-1">Changelog</a>).
170+
</li>
169171
<li><strong>December 2022.</strong> scikit-learn 1.2.0 is available for download (<a href="whats_new/v1.2.html#version-1-2-0">Changelog</a>).
170172
</li>
171173
<li><strong>October 2022.</strong> scikit-learn 1.1.3 is available for download (<a href="whats_new/v1.1.html#version-1-1-3">Changelog</a>).

0 commit comments

Comments
 (0)
0