From 1b887c1d81b1ee81db1838f697ce0a4aad7933aa Mon Sep 17 00:00:00 2001 From: Badr-MOUFAD Date: Tue, 12 Dec 2023 14:59:45 +0100 Subject: [PATCH 1/3] hide toctree --- doc/index.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 194a2e4b7..68855b7e5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -79,11 +79,13 @@ You are free to use it and if you do so, please cite year = {2022}, -Explore the documentation -------------------------- +.. it mandatory to keep the toctree here although it doesn't show up in the page +.. when adding/modifying pages, don't forget to update the toctree .. toctree:: :maxdepth: 1 + :hidden: + :includehidden: getting_started.rst tutorials/tutorials.rst From 46c9a331e56b7dfa9c30bbf3ff8eab461165dd3f Mon Sep 17 00:00:00 2001 From: Badr-MOUFAD Date: Tue, 12 Dec 2023 15:07:01 +0100 Subject: [PATCH 2/3] fix typo --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 68855b7e5..a8b17ce0f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -79,7 +79,7 @@ You are free to use it and if you do so, please cite year = {2022}, -.. it mandatory to keep the toctree here although it doesn't show up in the page +.. it is mandatory to keep the toctree here although it doesn't show up in the page .. when adding/modifying pages, don't forget to update the toctree .. toctree:: From c660cbbf66d1c147970973ce3c52a2da3457d872 Mon Sep 17 00:00:00 2001 From: Badr-MOUFAD Date: Tue, 12 Dec 2023 15:08:07 +0100 Subject: [PATCH 3/3] fix import in readme example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 51fa06153..e845dfeec 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ from skglm.datafits import Huber from skglm.penalties import MCPenalty from skglm.estimators import GeneralizedLinearEstimator -from skglm.utils import make_correlated_data +from skglm.utils.data import make_correlated_data from skglm.solvers import AndersonCD X, y, _ = make_correlated_data(n_samples=10, n_features=100)