Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MNT make linkcheck run without errors #23775

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

Jump to bottom
Merged
merged 2 commits into from
Jun 29, 2022
Merged

MNT make linkcheck run without errors #23775

merged 2 commits into from
Jun 29, 2022

Conversation

lesteve
Copy link
Member

@lesteve lesteve commented Jun 28, 2022

Follow-up of #23631.

With these changes make linkcheck runs without any error.

The remaining issues were:

  • some links were fixed in a single place rather than everywhere in the project
  • some links were fixed but they needed to be added to lincheck_ignore since make linkcheck flags them as broken but they work fine in a browser

@lesteve lesteve added the Quick Review For PRs that are quick to review label Jun 28, 2022
@lesteve lesteve mentioned this pull request Jun 28, 2022
Closed
34 tasks
lesteve
lesteve commented Jun 28, 2022
View reviewed changes
doc/modules/decomposition.rst Outdated
@@ -956,7 +956,7 @@ is not readily available from the start, or when the data does not fit into memo

.. [4] `"SVD based initialization: A head start for nonnegative
matrix factorization"
<https://www.cb.uu.se/~milan/histo/before2011august/Boutsidis.pdf>`_
<http://www.boutsidis.org/Boutsidis_PRE_08.pdf>`_
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed this link to use one of the author personal page

lesteve
lesteve commented Jun 28, 2022
View reviewed changes
doc/conf.py
"for_Skewed_Multiplicative_Histogram_Kernels",
"https://www.researchgate.net/publication/4974606_"
"Hedonic_housing_prices_and_the_demand_for_clean_air",
"https://www.researchgate.net/profile/Anh-Huy-Phan/publication/220241471_Fast_"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I grouped the researchgate links together here

lesteve
lesteve commented Jun 28, 2022
View reviewed changes
sklearn/cluster/_spectral.py
A. V. Knyazev
SIAM Journal on Scientific Computing 23, no. 2, pp. 517-541.
<https://epubs.siam.org/doi/pdf/10.1137/S1064827500366124>`_
<10.1137/S1064827500366124>`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the DOI for consistency with the links to the same article in this file. Also IIRC make linkcheck flag the epubs.siam.org link as broken

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this DOI link does not lead to a downloadable PDF for me.

Maybe we should use https://www.researchgate.net/profile/Andrew-Knyazev/publication/2434555_Toward_The_Optimal_Preconditioned_Eigensolver_Locally_Optimal_Block_Preconditioned_Conjugate_Gradient_Method/links/5f1e060f299bf1720d67f9a7/Toward-The-Optimal-Preconditioned-Eigensolver-Locally-Optimal-Block-Preconditioned-Conjugate-Gradient-Method.pdf instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PDF link above those not directly link to the PDF. It redirects to an HTML page from which it's possible to download the PDF by clicking in a browser (probably with javascript enabled).

Maybe we should link to the HTML page then: https://www.researchgate.net/publication/2434555_Toward_The_Optimal_Preconditioned_Eigensolver_Locally_Optimal_Block_Preconditioned_Conjugate_Gradient_Method

Copy link
Member

@ogrisel ogrisel Jun 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the following link directly leads to the PDF:

https://www.researchgate.net/profile/Andrew-Knyazev/publication/2434555_Toward_The_Optimal_Preconditioned_Eigensolver_Locally_Optimal_Block_Preconditioned_Conjugate_Gradient_Method/links/5f1e060f299bf1720d67f9a7/Toward-The-Optimal-Preconditioned-Eigensolver-Locally-Optimal-Block-Preconditioned-Conjugate-Gradient-Method.pdf?origin=publication_detail

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest we have the DOI vs publically accessible PDF separately. This PR's goal is to get make linkcheck to run without errors.

Also this particular link (through the DOI) in used in multiple places:

❯ git grep 10.1137/S1064827500366124
sklearn/cluster/_spectral.py:           <10.1137/S1064827500366124>`
sklearn/cluster/_spectral.py:           <10.1137/S1064827500366124>`
sklearn/externals/_lobpcg.py:       pp. 517-541. :doi:`10.1137/S1064827500366124`
sklearn/externals/_lobpcg.py:           pp. 517-541. :doi:`10.1137/S1064827500366124`
sklearn/manifold/_spectral_embedding.py:      <10.1137/S1064827500366124>`

ogrisel
ogrisel approved these changes Jun 28, 2022
View reviewed changes
Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are two http links that seem to work in https (in Firefox).

Otherwise, LGTM.

doc/about.rst
@@ -423,7 +423,7 @@ time of Joris van den Bossche (2017-2018).
.. image:: images/cds-logo.png
:width: 100pt
:align: center
:target: https://www.datascience-paris-saclay.fr/
:target: http://www.datascience-paris-saclay.fr/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is sad... I sent an email to the contact address to let them know that the TLS certificate has expired (in August 2020).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had the same feeling ;)

glemaitre
glemaitre approved these changes Jun 28, 2022
View reviewed changes
Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM apart of the 2 changes proposed by @ogrisel

@glemaitre glemaitre merged commit 34f3e0e into scikit-learn:main Jun 29, 2022
@glemaitre
Copy link
Member

Thanks @lesteve

@lesteve lesteve deleted the make-linkcheck-happy branch June 29, 2022 12:37
ogrisel added a commit to ogrisel/scikit-learn that referenced this pull request Jul 11, 2022
@lesteve @ogrisel
MAINT make linkcheck run without errors (scikit-learn#23775)
88c40a4 
Co-authored-by: Olivier Grisel <[email protected]>
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
@lesteve @ogrisel @glemaitre
MAINT make linkcheck run without errors (scikit-learn#23775)
e281c47 
Co-authored-by: Olivier Grisel <[email protected]>
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
@lesteve @ogrisel @glemaitre
MAINT make linkcheck run without errors (#23775)
b7987b4 
Co-authored-by: Olivier Grisel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ogrisel ogrisel ogrisel approved these changes

@glemaitre glemaitre glemaitre approved these changes

Assignees
No one assigned
Labels
module:cluster module:cross_decomposition module:decomposition Quick Review For PRs that are quick to review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lesteve @glemaitre @ogrisel