Skip to content
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

Close #9016: linkcheck builder failed to check the anchors of github.com #9260

Merged
merged 4 commits into from Jun 3, 2021
Merged

Close #9016: linkcheck builder failed to check the anchors of github.com #9260

merged 4 commits into from Jun 3, 2021

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented May 22, 2021

@tk0miya tk0miya added type:bug type:enhancement enhance or introduce a new feature builder:linkcheck labels May 22, 2021
francoisfreitag
francoisfreitag reviewed May 28, 2021
View reviewed changes
Copy link
Contributor

@francoisfreitag francoisfreitag left a comment

Choose a reason for hiding this comment

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

It is quite useful to link to a section of GitHub rendered markup. I think the benefits outweights the maintenance burden.

Perhaps add a test for the rewriting, e.g. linking to https://github.com/sphinx-doc/sphinx#documentation?
That way, we’ll know if GitHub changes their prefix.

sphinx/builders/linkcheck.py Outdated Show resolved Hide resolved
sphinx/builders/linkcheck.py Show resolved Hide resolved
@tk0miya
Copy link
Member Author

tk0miya commented May 30, 2021

@francoisfreitag Thank you for your opinion. Okay, I'll continue to implement this.

@tk0miya tk0miya added this to the 4.1.0 milestone May 31, 2021
@tk0miya tk0miya changed the title Concept: Close #9016: linkcheck builder failed to check the anchors of github.com Close #9016: linkcheck builder failed to check the anchors of github.com May 31, 2021
@tk0miya tk0miya force-pushed the 9016_linkcheck_github_anchors branch from bf14d3a to 92335bd Compare May 31, 2021 15:31
@tk0miya tk0miya removed the type:bug label May 31, 2021
@tk0miya
Copy link
Member Author

tk0miya commented May 31, 2021

Just updted!

francoisfreitag
francoisfreitag previously approved these changes May 31, 2021
View reviewed changes
Copy link
Contributor

@francoisfreitag francoisfreitag left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM, thanks!

CHANGES Outdated Show resolved Hide resolved
@francoisfreitag francoisfreitag dismissed their stale review May 31, 2021 15:44

Suggestion coming.

francoisfreitag
francoisfreitag approved these changes Jun 3, 2021
View reviewed changes
Copy link
Contributor

@francoisfreitag francoisfreitag left a comment

Choose a reason for hiding this comment

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

Great, thanks!

@tk0miya tk0miya merged commit 1418e3a into sphinx-doc:4.x Jun 3, 2021
@tk0miya
Copy link
Member Author

tk0miya commented Jun 3, 2021

Thank you for reviewing!

@tk0miya tk0miya deleted the 9016_linkcheck_github_anchors branch June 3, 2021 16:18
@amotl
Copy link

amotl commented Jun 3, 2021

Dear Takeshi and François,

thanks a stack for bringing in this excellent improvement.

With kind regards,
Andreas.

@amotl amotl mentioned this pull request Jun 3, 2021
Open
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@francoisfreitag francoisfreitag francoisfreitag approved these changes

Assignees
No one assigned
Labels
builder:linkcheck type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
4.1.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@tk0miya @amotl @francoisfreitag