8000 [WIP] Fix broken/redirection linkcheck by remyleone · Pull Request #5968 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

[WIP] Fix broken/redirection linkcheck #5968

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
Closed
wants to merge 2 commits into from
Closed

[WIP] Fix broken/redirection linkcheck #5968

wants to merge 2 commits into from

Conversation

remyleone
Copy link
Contributor

Fix some redirection and broken links. There is several things I need help with :

  1. How can we do a verification inside a travis job without blocking the build? Sometimes a linkcheck verification time out even if the targetted website is up.
  2. What's the deal with the previous versions scikit-learn documentation? In doc/support.rst the links seems to be broken. Where is the documentation ?

@remyleone remyleone mentioned this pull request Dec 6, 2015
Closed
agramfort
agramfort reviewed Dec 6, 2015
View reviewed changes
doc/modules/clustering.rst
@@ -1158,7 +1158,7 @@ calculated using a similar form to that of the adjusted Rand index:
* Vinh, Epps, and Bailey, (2009). "Information theoretic measures
for clusterings comparison". Proceedings of the 26th Annual International
Conference on Machine Learning - ICML '09.
`doi:10.1145/1553374.1553511 <http://dx.doi.org/10.1145/1553374.1553511>`_.
`doi:10.1145/1553374.1553511 <https://dl.acm.org/citation.cfm?doid=1553374.1553511>`_.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this one is needed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should the complete reference be removed?

@agramfort
Copy link
Member

how did you fix all these links?

@raghavrv
Copy link
Member
raghavrv commented Dec 6, 2015

Thanks a lot for tackling this!!

@remyleone
Copy link
Contributor Author

@agramfort Basically I used the output created by make linkcheck in the doc/output/linkcheck folder. After that, I simply used regexp to do the change. For the broken links most of the time, the paper was one google search away.

@remyleone
Copy link
Contributor Author

@rvraghav93 Thank you very much :) I have trouble seeing how we could automate this. For instance, we have redirection such as blogspot.com => blogspot.fr that are done and inject redirect warnings.
An other problem is that some websites are very slow and raise a timeout. I'm afraid that most of the checking would have to be done by humans once in a while.

A possible hack would be to have a warning counter and raise a warning when it's increasing.

@raghavrv
Copy link
Member
raghavrv commented Dec 7, 2015

Sphinx has a link checker IIRC... Someone did post that in one of the issues. I am not able to find that though :/

@remyleone
Copy link
Contributor Author

Indeed, I'm using the one from sphinx.

2015-12-07 13:58 GMT+01:00 Raghav R V notifications@github.com:

Sphinx has a link checker IIRC... Someone did post that in one of the
issues. I am not able to find that though :/

—
Reply to this email directly or view it on GitHub
#5968 (comment)
.

@raghavrv
Copy link
Member
raghavrv commented Dec 7, 2015

Oh you mean automating the correction of links? ;)

@remyleone
Copy link
Contributor Author

Even the detection would be nice :)

2015-12-07 14:14 GMT+01:00 Raghav R V notifications@github.com:

Oh you mean automating the correction of links? ;)

—
Reply to this email directly or view it on GitHub
#5968 (comment)
.

@amueller
Copy link
Member
amueller commented Dec 8, 2015

thanks a lot. I'm indecisive about the http->https but why not.

@amueller
Copy link
Member
amueller commented Dec 8, 2015

did you fix the link to the contributors guide in #5933? that would be kind of important.

@amueller
Copy link
Member
amueller commented Dec 8, 2015

actually not sure sphinx even reports on this.... I think I'll just change it.

@nelson-liu nelson-liu mentioned this pull request Jan 14, 2016
Closed
@remyleone remyleone closed this Feb 8, 2016
@remyleone remyleone deleted the fix_broken_links branch February 8, 2016 15:04
@raghavrv
Copy link
Member
raghavrv commented Feb 8, 2016

@sieben Why have you closed this?

@remyleone
Copy link
Contributor Author

Wasn't merged or neither getting attention.

Le lun. 8 févr. 2016 à 20:32, Raghav R V notifications@github.com a
écrit :

@sieben https://github.com/sieben Why have you closed this?

—
Reply to this email directly or view it on GitHub
#5968 (comment)
.

@raghavrv
Copy link
Member

The scikit learn review process is pretty slow... please dont be discouraged by that. Could you please reopen it. This is pretty useful.

@GaelVaroquaux
Copy link
Member

It's entitled "WIP". I tend not to focus on WIP pull request to review.

@nelson-liu
Copy link
Contributor

@sieben what is WIP about the PR? I can try to help if you'd like that.

@nelson-liu
Copy link
Contributor

@sieben if you don't want to reopen the PR, would you be fine with me cherry picking the commit and opening / maintaining a new PR?

@nelson-liu nelson-liu mentioned this pull request Feb 22, 2016
Closed
@remyleone
Copy link
Contributor Author

@nelson-liu No problem feel free to cherry pick. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@remyleone @agramfort @raghavrv @amueller @GaelVaroquaux @nelson-liu
0